Re: Real documentation?

["Richard Heyes" <richard.heyes@heyes-computing.net>] > > I recently proposed a central "doc" dir where packages documentation are > > installed separatly in the form: doc/<package_name-release>/. In your > > package simply create a dir called "doc" and mark it as Role="doc": > > > > <FileList> > > <Dir Name="/" Role="php"> > > <File>Mail.php</File> > > <Dir Name="Mail"> > > <File>sendmail.php</File> > > <Dir Name="doc" Role="doc"> > > <File>examples_sendmail.php</File> > > </Dir> > > </Dir> > > </Dir> > > </FileList> > > Sounds good, but doesn't the above imply the docs dir sitting in the same > place as the file? > > > The installer could be easily modified to install all the 'Role="doc"' > > files under PEAR_DOC_DIR/mail-1.2/ (PEAR_DOC_DIR is a new php constant). > > This new constant or something similiar (PHP_DATA_DIR/peardocs?) is > > needed because we probably don't want to have all the docs and examples > > under the include_path. > > Where would they sit in cvs though, /doc(s)/package_name/ perhaps? Naah, package_name/doc(s) is better. Keep it close to the source, then the developer is more likely to remember updating it. Anyway, the package XML file will basically let you put it anywhere, as long as you tag the files as documentation files in a supported format. - Stig -- Stig Sæther Bakken <ssb@alltheweb.com> Fast Search & Transfer ASA, Trondheim, Norway