提交 040d3f77 编写于 作者: E Eric Blake

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: NEric Blake <eblake@redhat.com>
上级 5598f81f
...@@ -103,11 +103,8 @@ and run the tests: ...@@ -103,11 +103,8 @@ and run the tests:
make syntax-check make syntax-check
make -C tests valgrind 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 If you encounter any failing tests, the VIR_TEST_DEBUG environment variable
may provide extra information to debug the failures. Larger values of 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 ...@@ -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 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 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 code paths. The format of the entry can be found in the documentation found at
the the Valgrind home page <http://valgrind.org/>. The following trace was added
to "tests/.valgrind.supp" in order to suppress the warning:
Valgrind home page.
http://valgrind.org/The following trace was added to "tests/.valgrind.supp" in order to suppress
the warning:
{ {
dlInitMemoryLeak1 dlInitMemoryLeak1
...@@ -211,10 +205,8 @@ feature or changing the output of a program. ...@@ -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 There is more on this subject, including lots of links to background reading
on the subject, on 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/>.
Richard Jones' guide to working with open source projects
http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/
Code indentation Code indentation
...@@ -893,9 +885,7 @@ logic would be better pulled out into a helper function. ...@@ -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 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 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: When using goto, please use one of these standard labels if it makes sense:
......
...@@ -211,7 +211,7 @@ ...@@ -211,7 +211,7 @@
not suppress real leaks, but it should be generic enough to not suppress real leaks, but it should be generic enough to
cover multiple code paths. The format of the entry can be cover multiple code paths. The format of the entry can be
found in the documentation found at the 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> The following trace was added to <code>tests/.valgrind.supp</code>
in order to suppress the warning: in order to suppress the warning:
</p> </p>
...@@ -236,7 +236,7 @@ ...@@ -236,7 +236,7 @@
There is more on this subject, including lots of links to background There is more on this subject, including lots of links to background
reading on the subject, on reading on the subject, on
<a href="http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/"> <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> </p>
......
...@@ -27,4 +27,14 @@ ...@@ -27,4 +27,14 @@
<xsl:template match="html:i">'<xsl:apply-templates/>'</xsl:template> <xsl:template match="html:i">'<xsl:apply-templates/>'</xsl:template>
<xsl:template match="html:code">"<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> </xsl:stylesheet>
...@@ -138,12 +138,4 @@ from docs/hacking.html.in! ...@@ -138,12 +138,4 @@ from docs/hacking.html.in!
</xsl:template> </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> </xsl:stylesheet>
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册