Re: documenting new function

On Fri, 24 Jan 2003, Maxim Maletsky wrote: > Guys, > > A few months ago, I added a new function to the OCI8 extension which is > currently in HEAD ready to go with the next release. > > Now, I am quite unsure where to begin documenting it. I used modifying the > doc files but not adding the new ones. > > What set of files exactly are for me to edit/create? Or will the man-build > create the skeleton for this very function once found its proto? I guess > this would happen after the HEAD was branched for the next release, > right? > > Anyhow, I'd appreciate if someone of you would tell me the steps for > adding a new function to the manual. Here is how to add a function: a) copy xml file from another function, rename it to ocipasswordchange.xml b) edit this file, edit out the stuff that shouldn't be in there. document your function. c) cd phpdoc/ d) ./configure e) make test f) fix errors, repeat (e) g) cvs add en/your/function/name.xml h) cvs commit en/your/function/name.xml That's it. Everything else is taken care of, such as version numbers. ./configure will modify functions.xml as you do not touch it. Do not write what version this was added either. Regarding NEWS, that's a php-dev thing. Regards, Philip