docs: treat the test description as cdata
authorThomas Wood <thomas.wood@intel.com>
Fri, 28 Nov 2014 11:37:33 +0000 (11:37 +0000)
committerThomas Wood <thomas.wood@intel.com>
Thu, 4 Dec 2014 16:07:55 +0000 (16:07 +0000)
Enclose the test description in cdata tags since the test descriptions
come from the tests themselves and may not be escaped for use in xml.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
docs/reference/intel-gpu-tools/Makefile.am

index b40680b..0a47764 100644 (file)
@@ -36,14 +36,14 @@ xml/igt_test_programs_%_description.xml: $(TESTLISTS)
        for test in `cat $(TESTLISTS) | tr ' ' '\n' | grep "^$*" | sort`; do \
                echo "<refsect2 id=\"$$test\"><title>" >> $@; \
                echo "$$test" | perl -pe 's/(?<=_)$(KEYWORDS)(?=(_|\W))/<acronym>\1<\/acronym>/g' >> $@; \
-               echo "</title><para>" >> $@; \
+               echo "</title><para><![CDATA[" >> $@; \
                if [ -x $(top_builddir)/tests/$$test ]; then \
                        testprog=$(top_builddir)/tests/$$test; \
                else \
                        testprog=$(top_srcdir)/tests/$$test; \
                fi; \
                 ./$$testprog --help-description >> $@; \
-               echo "</para>" >> $@; \
+               echo "]]></para>" >> $@; \
                if ./$$testprog --list-subtests > /dev/null ; then \
                        echo "<refsect3><title>Subtests</title>" >> $@; \
                        echo "<simplelist>" >> $@; \