maint: tweak use of <a> in HACKING

The previous handling of <a> tags led to some less-than-ideal
layout in HACKING (most noticeable on a mid-sentence reference
to the valgrind home page).

* docs/hacking.html.in: Slight tweaks to <a> tags.
* docs/hacking1.xsl: Move <a> handling...
* docs/hacking2.xsl: ...here.
* HACKING: Regenerate.

Signed-off-by: Eric Blake <eblake@redhat.com>

diff --git a/HACKING b/HACKING
index a310faa067d51670d0859df0edbc3f724f3b4125..271ff6cff5d4d57f7bfbd96edf8a983761438173 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -103,11 +103,8 @@ and run the tests:
   make syntax-check
   make -C tests valgrind
 
-
-
-  Valgrind
-  http://valgrind.org/is a test that checks for memory management issues, such as leaks or use of
-uninitialized variables.
+Valgrind <http://valgrind.org/> is a test that checks for memory management
+issues, such as leaks or use of uninitialized variables.
 
 If you encounter any failing tests, the VIR_TEST_DEBUG environment variable
 may provide extra information to debug the failures. Larger values of
@@ -186,11 +183,8 @@ In this instance, it is acceptible to modify the "tests/.valgrind.supp" file
 in order to add a suppression filter. The filter should be unique enough to
 not suppress real leaks, but it should be generic enough to cover multiple
 code paths. The format of the entry can be found in the documentation found at
-the
-
-  Valgrind home page.
-  http://valgrind.org/The following trace was added to "tests/.valgrind.supp" in order to suppress
-the warning:
+the Valgrind home page <http://valgrind.org/>. The following trace was added
+to "tests/.valgrind.supp" in order to suppress the warning:
 
 {
     dlInitMemoryLeak1
@@ -211,10 +205,8 @@ feature or changing the output of a program.
 
 
 There is more on this subject, including lots of links to background reading
-on the subject, on
-
-  Richard Jones' guide to working with open source projects
-  http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/
+on the subject, on Richard Jones' guide to working with open source projects
+<http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/>.
 
 
 Code indentation
@@ -893,9 +885,7 @@ logic would be better pulled out into a helper function.
 
 Although libvirt does not encourage the Linux kernel wind/unwind style of
 multiple labels, there's a good general discussion of the issue archived at
-
-  KernelTrap
-  http://kerneltrap.org/node/553/2131
+KernelTrap <http://kerneltrap.org/node/553/2131>
 
 When using goto, please use one of these standard labels if it makes sense:
 

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 904b846e0168f3eda125cac6ed5b36ac447956b4..41c8d481a6a7bdd2af062a44c7a17387b3582895 100644 (file)
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -211,7 +211,7 @@
            not suppress real leaks, but it should be generic enough to
            cover multiple code paths. The format of the entry can be
            found in the documentation found at the
-           <a href="http://valgrind.org/">Valgrind home page.</a>
+           <a href="http://valgrind.org/">Valgrind home page</a>.
            The following trace was added to <code>tests/.valgrind.supp</code>
            in order to suppress the warning:
         </p>
@@ -236,7 +236,7 @@
       There is more on this subject, including lots of links to background
       reading on the subject, on
       <a href="http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/">
-        Richard Jones' guide to working with open source projects</a>
+        Richard Jones' guide to working with open source projects</a>.
     </p>
 
 

diff --git a/docs/hacking1.xsl b/docs/hacking1.xsl
index cdeb3a42592f30f6b9f5ebc28ab1be3f7ed45f1d..e70b45d94d2364e0fcb07cd906bf1e5ad40f7f66 100644 (file)
--- a/docs/hacking1.xsl
+++ b/docs/hacking1.xsl
@@ -27,4 +27,14 @@
 <xsl:template match="html:i">'<xsl:apply-templates/>'</xsl:template>
 <xsl:template match="html:code">"<xsl:apply-templates/>"</xsl:template>
 
+<!-- likewise, reformat a tags in first pass -->
+<xsl:template match="html:a">
+<xsl:text> </xsl:text><xsl:apply-templates/>
+<xsl:if test="@href">
+  <xsl:text> &lt;</xsl:text><xsl:value-of select="@href"/>
+  <xsl:text>&gt;</xsl:text>
+</xsl:if>
+</xsl:template>
+
+
 </xsl:stylesheet>

diff --git a/docs/hacking2.xsl b/docs/hacking2.xsl
index 72fa9d30141c9dafd45cc7ce727454627d67d59e..1c9271f29d01e59599424b5227404c89d8449038 100644 (file)
--- a/docs/hacking2.xsl
+++ b/docs/hacking2.xsl
@@ -138,12 +138,4 @@ from docs/hacking.html.in!
 </xsl:template>
 
 
-
-<xsl:template match="html:a">
-<xsl:value-of select="$newline"/><xsl:value-of select="$newline"/>
-<xsl:text>  </xsl:text><xsl:apply-templates/>
-<xsl:value-of select="$newline"/>
-<xsl:text>  </xsl:text><xsl:value-of select="@href"/>
-</xsl:template>
-
 </xsl:stylesheet>