crossley 2003/12/18 00:47:46
Modified: site/community committer.html
Log:
Add section about xml validation.
Revision Changes Path
1.5 +26 -2 cocoon-site/site/community/committer.html
Index: committer.html
===================================================================
RCS file: /home/cvs/cocoon-site/site/community/committer.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- committer.html 12 Dec 2003 07:39:39 -0000 1.4
+++ committer.html 18 Dec 2003 08:47:46 -0000 1.5
@@ -178,6 +178,9 @@
<li>
<a href="#dos2unix">dos2unix and other control-characters</a>
</li>
+<li>
+<a href="#valid-xml">Valid XML instances</a>
+</li>
</ul>
<a name="N1000C"></a><a name="overview"></a>
@@ -276,8 +279,7 @@
To add the ^M use "Ctrl-v Ctrl-m" at the command-line.
Note that copy-and-paste will not work.
The -w can be omitted, but might then match some extra filenames.
-
- </pre>
+</pre>
<p>
To instead find <em>all</em> files (including images and foreign
jar archives) that have DOS line-endings:
@@ -290,6 +292,28 @@
<span class="codefrag">find . -type f | xargs grep -l
'[[:cntrl:]]'</span>
</p>
+</div>
+
+
+<a name="N10086"></a><a name="valid-xml"></a>
+<h3>Valid XML instances</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>
+ Many of us have wasted time with a broken build due to xml validation
+ errors. Would all committers please either use a proper xml editor or
+ validate their xdocs with one of the following commands:
+ </p>
+<pre class="code">
+onsgmls -c $COCOON_HOME/src/webapp/WEB-INF/entities/catalog \
+-wall -wxml -s mydoc.xml
+ </pre>
+<pre class="code">
+export SGML_CATALOG_FILES=$COCOON_HOME/src/webapp/WEB-INF/entities/catalog
+xmllint --valid --catalogs --noout mydoc.xml
+ </pre>
+<pre class="code">
+forrest validate-xdocs
+ </pre>
</div>