From: Christophe Jaillet <jailletc36@apache.org>
Date: Fri, 15 Feb 2019 07:25:54 +0000 (+0000)
Subject: Add some additional tests to report badly formatted synopsis.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=aebde8b3af79e6f9829deab848d36eb29fd1e513;p=apache

Add some additional tests to report badly formatted synopsis.
Comment-out these tests because of the noise it generates, but leave it there, if useful for s.o.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1853615 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/style/xsl/quickreference.xsl b/docs/manual/style/xsl/quickreference.xsl
index c6c9afc735..340f5eb54e 100644
--- a/docs/manual/style/xsl/quickreference.xsl
+++ b/docs/manual/style/xsl/quickreference.xsl
@@ -319,14 +319,28 @@
             </xsl:choose>
         </xsl:variable>
 
-        <!-- Check if the default string really starts with the directive -->
-        <!-- name, in order to avoid typo, or unexpected formatting.      -->
-        <!-- Below, we skip the directive name, so, for it to work, it    -->
-        <!-- must be there.                                               -->
+        <!-- Check if the syntax and the default strings really start with -->
+        <!-- the directive name, in order to avoid typo, or unexpected     -->
+        <!-- formatting.                                                   -->
+        <!-- Un-comment these lines if you want to perform this additional -->
+        <!-- tests.  They are not run by default, because of the false     -->
+        <!-- positives and the noise they generate.                        -->
+<!--
+        <xsl:if test="string-length(syntax) = 0 or
+                         (syntax != name and
+                          substring-before(syntax, ' ') != name and
+                          substring-before(syntax, ' ') != concat ('&lt;', name) and
+                          substring-before(syntax, ' ') != concat ('&lt;', name, '&gt;')
+                         )" >
+                      
+            <xsl:message>Spurious syntax string for <xsl:value-of select="name"/>: '<xsl:value-of select="syntax"/>'</xsl:message>
+        </xsl:if>
+
         <xsl:if test="string-length($default) &gt; 0
                       and substring-before($default, ' ') != name">
-            <xsl:message>Spurious default string: <xsl:value-of select="$default"/> (Directive <xsl:value-of select="name"/> omitted or misspelled)</xsl:message>
+            <xsl:message>Spurious default string for <xsl:value-of select="name"/>: <xsl:value-of select="$default"/></xsl:message>
         </xsl:if>
+-->
 
         <!-- Now. If the default output is empty, the xslt processor emits -->
         <!-- <td />. In order to avoid this, we simply emit <td></td>      -->