Re: Documenting new extension (inotify)

On Fri, Oct 24, 2008 at 03:04, Kalle Sommer Nielsen <kalle.php@gmail.com> wrote: > Hi Arnaud > > 2008/10/24 Arnaud Le Blanc <lbarnaud@php.net>: >> Hi, >> >> I would like to document my extension, I did a checkout of phpdoc, added >> required files [1], modified manual.xml.in to add reference.inotify.book in >> the filesystem category, and verified the changes by generating a local >> documentation. > > The code looks good, I noticed that your revision numbers are very > different, I would > suggest starting at 1.0, then they will become 1.1 at checkin and $Revision: $ is CVS keyword which is replaced by CVS automatically when committing, he probably copied stuff from other extensions (rather then from RFC/skeletons/). >> Can I commit that or are there anything to do to before ? The entities.functions.xml is autogenerated (by "php configure.php") and should not be in CVS (hence the .cvsignore entry :) Personally, I prefer to keep all "setup" related stuff inside setup.xml, rather then keeping 10lines in separate files (resources.xml, install.xml).. For repeated sentence (i.e. $resource parameter description) it is "best practice" to create an entity for it (in en/language-snippets.ent), see &mysql.linkid.description; for example. Quickly reading the markup, without trying to render it, it looks great. Feel free to commit. -Hannes