philip Wed Aug 4 17:17:11 2004 EDT
Modified files:
/phpdoc README
/phpdoc/howto generating.xml
Log:
Document use of 'make test_xml' and xml-check.php
http://cvs.php.net/diff.php/phpdoc/README?r1=1.32&r2=1.33&ty=u
Index: phpdoc/README
diff -u phpdoc/README:1.32 phpdoc/README:1.33
--- phpdoc/README:1.32 Fri Apr 11 11:25:28 2003
+++ phpdoc/README Wed Aug 4 17:17:11 2004
@@ -71,7 +71,18 @@
make test
- Always 'make test' before commit!
+ Always 'make test' before commit! In order to check the validity
+ of your XML you may run the following command (requires xmllint):
+
+ make test_xml
+
+ Because test_xml 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
http://cvs.php.net/diff.php/phpdoc/howto/generating.xml?r1=1.13&r2=1.14&ty=u
Index: phpdoc/howto/generating.xml
diff -u phpdoc/howto/generating.xml:1.13 phpdoc/howto/generating.xml:1.14
--- phpdoc/howto/generating.xml:1.13 Thu Nov 14 21:46:01 2002
+++ phpdoc/howto/generating.xml Wed Aug 4 17:17:11 2004
@@ -107,7 +107,32 @@
Using this information, you can go back to the file and correct
the mistake before committing your changes.
</para>
-
+
+ <para>
+ In order to check the validity of your XML you may use
+ <literal>make test_xml</literal> as this executes a
+ <filename>xmllint</filename> check on the entire phpdoc tree. This
+ will find problems 'make text' ignores, problems like a missing ; or
+ & for an entity. This will take a long time execute.
+ </para>
+ <para>
+ <informalexample>
+ <programlisting>
+$ cd phpdoc
+$ make test_xml
+ </programlisting>
+ </informalexample>
+ </para>
+ <para>
+ Or to simply check the XML validity of one file you may use the
+ <filename>xml-check.php</filename> script that's found in the phpdoc
+ <filename>scripts/</filename> directory, and use it like so:
+ <informalexample>
+ <programlisting>
+$ scripts/xml-check.php en/reference/mysql/functions/mysql-connect.xml
+ </programlisting>
+ </informalexample>
+ </para>
<para>
It is important to do a test before commiting, because if you
commit files with errors, this single file will cause the automatic
