cvs: phpdoc / README

bjori Fri Dec 28 01:31:18 2007 UTC Modified files: /phpdoc README Log: Minor updates regarding file locations (new-ref-struct) and testing (configure.php) http://cvs.php.net/viewvc.cgi/phpdoc/README?r1=1.37&r2=1.38&diff_format=u Index: phpdoc/README diff -u phpdoc/README:1.37 phpdoc/README:1.38 --- phpdoc/README:1.37 Fri Aug 17 00:54:56 2007 +++ phpdoc/README Fri Dec 28 01:31:17 2007 @@ -37,13 +37,21 @@ --------------------------------------------------------------------------- The file locations are as follows: - {lang}/reference/{extension}/functions/{function}.xml - /configure.xml + {lang}/reference/{extension} + /setup.xml + /configure.xml [often part of setup.xml] /constants.xml - /ini.xml + /ini.xml [often part of setup.xml] + + When the extension defines functions: + /functions/{function}.xml /reference.xml - /functions.xml (autogenerated) + When the exetnsion defines classess: + /{classname}.xml + /{classname}/{methodname}.xml + + /entities.*.xml (autogenerated) Translated files live within their own CVS modules. @@ -59,25 +67,21 @@ whitespace changes aren't mixed in: cvs diff -u path/to/file.xml + + Hint: Use the .cvsrc example from http://php.net/anoncvs c) Make sure no errors are present, so at the command line in your phpdoc source directory run: - make test + php configure.php - Always 'make test' before commit! In order to check the validity - of your XML you may run the following command (requires xmllint): + Always 'php configure.php' before commit! - make test_xml - - Because test_xml takes so long you may instead check one file at a + Because configure.php takes so long you may instead check one file at a time by using the xml-check.php script like so: scripts/xml-check.php en/reference/mysql/functions/mysql-connect.xml - This will find other problems that 'make test' ignores, problems like - a forgotten & or ; on an entity. - d) Commit your changes cvs commit path/to/file.xml @@ -94,15 +98,13 @@ b) Edit. Be sure no leftover text exists. No tabs either. c) Now test locally before commit by first running - ./configure along with 'make test' as usual. + (php configure.php) d) cvs add path/to/yourfile.xml e) cvs commit path/to/yourfile.xml - Note that ./configure adds your function to functions.xml as - this allows 'make test' to test your new function. Also, note - that version numbers are taken care of elsewhere (don't worry + Note that the version numbers are taken care of elsewhere (don't worry about them) [[some popular tags and entities]]