[libvirt] [PATCH] maint: tweak use of <a> in HACKING

[Daniel Veillard]

On Mon, Jul 08, 2013 at 04:39:19PM -0600, Eric Blake wrote:
> 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 at redhat.com>
> ---
>  HACKING              | 24 +++++++-----------------
>  docs/hacking.html.in |  4 ++--
>  docs/hacking1.xsl    | 10 ++++++++++
>  docs/hacking2.xsl    |  8 --------
>  4 files changed, 19 insertions(+), 27 deletions(-)
> 
> diff --git a/HACKING b/HACKING
> index a310faa..271ff6c 100644
> --- 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 904b846..41c8d48 100644
> --- 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 cdeb3a4..e70b45d 100644
> --- 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> <</xsl:text><xsl:value-of select="@href"/>
> +  <xsl:text>></xsl:text>
> +</xsl:if>
> +</xsl:template>
> +
> +
>  </xsl:stylesheet>
> diff --git a/docs/hacking2.xsl b/docs/hacking2.xsl
> index 72fa9d3..1c9271f 100644
> --- 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>
> -- 
> 1.8.1.4

  ACK, only remark is that < > are not often used as delimiters
for URLs in text, but it makes the boundaries obvious, and fixes
the extra end of line added by current stylesheets so definitely
an improvement :-)

Daniel

-- 
Daniel Veillard      | Open Source and Standards, Red Hat
veillard at redhat.com  | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
http://veillard.com/ | virtualization library  http://libvirt.org/