philip Wed Dec 4 01:38:04 2002 EDT
Modified files:
/phpdoc README
Log:
Added file location and quick ref sections. Expanded section on howto use
phpdoc which now includes more links.
Index: phpdoc/README
diff -u phpdoc/README:1.28 phpdoc/README:1.29
--- phpdoc/README:1.28 Sun Jan 6 13:02:14 2002
+++ phpdoc/README Wed Dec 4 01:38:03 2002
@@ -16,12 +16,65 @@
DocBook on Linux or Windows, or what conventions you
should follow when writing phpdoc files, please refer
to the PHP Documentation HOWTO. You can find it in
- the howto directory of the phpdoc module. If you
- don't know how to produce HTML files from those XML
- files there, please download the howto.html.tar.gz
- from that directory.
+ the howto directory of the phpdoc module which can
+ be build locally like so:
- It can also be downloaded from the web easily:
- http://cvs.php.net/co.php/phpdoc/howto/howto.html.tar.gz
+ make howto
+ cd howto/html/
+ It can also be downloaded from the web or viewed online:
+ http://www.php.net/manual/howto/
+ http://cvs.php.net/co.php/phpdoc/howto/howto.html.tar.gz?p=1
+
+ For questions on how to use CVS, consult the anoncvs docs and
+ apply to your (phpdoc) needs. Remember to use your PHP CVS
+ username/password and checkout the module named phpdoc.
+ Translation information is located in the HOWTO.
+
+ http://www.php.net/anoncvs.php
+
+FILE LOCATIONS
+
+ The old archived phpdoc files still live in the phpdoc module
+ for historical purposes, do NOT edit them. For example:
+
+ OLD: All function definitions and reference info for extensions
+ used to be stored in single xml files:
+
+ {lang}/functions/{extension}.xml
+
+ NOW: They are now separate and the format looks like so:
+
+ {lang}/reference/{extension}/functions/{function}.xml
+ /configure.xml
+ /constants.xml
+ /ini.xml
+ /reference.xml
+
+ /functions.xml (autogenerated)
+
+QUICKREF
+
+ a) Make the change. Use spaces not tabs. Be sure to carefully
+ watch your whitespace!
+
+ b) Look at your unified diff, make sure it looks right and that
+ whitespace changes aren't mixed in:
+
+ cvs diff -u path/to/file.xml
+
+ c) Make sure no errors are present, so at the command line in your
+ phpdoc source directory run:
+
+ make test
+
+ Always 'make test' before commit!
+
+ d) Commit your changes
+
+ cvs commit path/to/file.xml
+
+ Read the HOWTO for more information. After reading the HOWTO,
+ email the phpdoc mailing list ([EMAIL PROTECTED]) with questions
+ and concerns.
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
