On Wed, May 11, 2005, Matthias Kurz wrote: > >Hi. > >Here it is. I welcome comments to improve the language, but send them >to me personally, not to the list. >Technical comments to the list, naturally. >Samples will be created after the basics are accepted. > > > (mk) > > >Proposal: OpenPKG documentation structure (First Draft) > >To ease the process of packaging for the OpenPKG developers and to help >the users to find informations quickly, there should be a clear documented >documentation structure. > >1. Classification of documentation >---------------------------------- > We will make a distinction between mandatory and auxilliary documentation. > Mandatory documentation is always installed while the installation of > auxilliary documentation can be controlled using the package manager > application. > For RPM there are the options --includedocs and --excludedocs and the > macro %_excludedocs, that defines the default behaviour. The global > setting for %_excludedocs is '1' which means, that auxilliary docs are > only installed, when the option --includedocs is given to rpm. [1] The > user can define a different default value in $HOME/.rpmmacros. > >2. Mandatory documentation >-------------------------- > In short, every documentation that an administrator of a "headless > peripheral host" needs for his daily work is considered "mandatory". This > are especially manual pages (%prefix/man) and GNU info files (%prefix/info). > When the packager decides that there should be more mandatory documentation > it should be placed under %prefix/share/<package>/docs.
I would include sample configuration and any text HOWTO files in this category. It would be nice to have something that turned info files into something useful (I generally read them with less since I find it far easier than navigating their ``improved'' way). Bill -- INTERNET: [EMAIL PROTECTED] Bill Campbell; Celestial Software LLC UUCP: camco!bill PO Box 820; 6641 E. Mercer Way FAX: (206) 232-9186 Mercer Island, WA 98040-0820; (206) 236-1676 URL: http://www.celestial.com/ The pinnacle of open systems is: when moving from vendor to vendor, the design flaws stay the same. ______________________________________________________________________ The OpenPKG Project www.openpkg.org Developer Communication List openpkg-dev@openpkg.org
