Re: Real documentation?

Richard Heyes wrote: > > > 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? > You build a package from the "pear" module (not "php4/pear") with a structure like: cvs: pear/Mail (in the near future) | +--Mail.php +--Mail | +--sendmail.php +--smtp.php +--mime.php (our mime class Richard :) +--doc | +--README_sendmail All the files related to the Mail package are under the same dir in the cvs. But when you build the package with the "pear" script, get Mail-1.2.tgz and finally install it, files will be placed so in your system: PEAR_INSTALL_DIR | +--Mail.php +--Mail | +--sendmail.php +--smtp.php +--mime.php PEAR_DOC_DIR (or whatever) | +--Mail-1.2 | +--README_sendmail Tomas V.V.Cox