NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

HACKING: Reduce vertical whitespace

Browse Source 
When generating the plain text version of the contributor
guidelines we add a ludicrous amount of vertical whitespace
in some spots. Tweak the XSLT stylesheet and regenerate the
now much better looking file.
This commit is contained in:
Andrea Bolognani 2017-01-04 14:46:21 +01:00
parent dd78da09b0
commit 6488a6c6e2
2 changed files with 4 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
HACKING
View File

@ -14,21 +14,15 @@ General tips for contributing patches
(1) Discuss any large changes on the mailing list first. Post patches early and (1) Discuss any large changes on the mailing list first. Post patches early and
listen to feedback. listen to feedback.
(2) Official upstream repository is kept in git ("git://libvirt.org/libvirt.git") (2) Official upstream repository is kept in git ("git://libvirt.org/libvirt.git")
and is browsable along with other libvirt-related repositories (e.g. and is browsable along with other libvirt-related repositories (e.g.
libvirt-python) online <http://libvirt.org/git/>. libvirt-python) online <http://libvirt.org/git/>.
(3) Patches to translations are maintained via the zanata project (3) Patches to translations are maintained via the zanata project
<https://fedora.zanata.org/>. If you want to fix a translation in a .po file, <https://fedora.zanata.org/>. If you want to fix a translation in a .po file,
join the appropriate language team. The libvirt release process automatically join the appropriate language team. The libvirt release process automatically
pulls the latest version of each translation file from zanata. pulls the latest version of each translation file from zanata.
(4) Post patches using "git send-email", with git rename detection enabled. You (4) Post patches using "git send-email", with git rename detection enabled. You
need a one-time setup of: need a one-time setup of:
@ -71,8 +65,6 @@ Moreover, such patch needs to be prefixed correctly with
"--subject-prefix=PATCHv2" appended to "git send-email" (substitute "v2" with "--subject-prefix=PATCHv2" appended to "git send-email" (substitute "v2" with
the correct version if needed though). the correct version if needed though).
(5) In your commit message, make the summary line reasonably short (60 characters (5) In your commit message, make the summary line reasonably short (60 characters
is typical), followed by a blank line, followed by any longer description of is typical), followed by a blank line, followed by any longer description of
why your patch makes sense. If the patch fixes a regression, and you know what why your patch makes sense. If the patch fixes a regression, and you know what
@ -83,8 +75,6 @@ You can use 'git shortlog -30' to get an idea of typical summary lines.
Libvirt does not currently attach any meaning to Signed-off-by: lines, so it Libvirt does not currently attach any meaning to Signed-off-by: lines, so it
is up to you if you want to include or omit them in the commit message. is up to you if you want to include or omit them in the commit message.
(6) Split large changes into a series of smaller patches, self-contained if (6) Split large changes into a series of smaller patches, self-contained if
possible, with an explanation of each patch and an explanation of how the possible, with an explanation of each patch and an explanation of how the
sequence of patches fits together. Moreover, please keep in mind that it's sequence of patches fits together. Moreover, please keep in mind that it's
@ -94,13 +84,9 @@ of a series, but intermediate patches must compile and not cause test-suite
failures (this is to preserve the usefulness of "git bisect", among other failures (this is to preserve the usefulness of "git bisect", among other
things). things).
(7) Make sure your patches apply against libvirt GIT. Developers only follow GIT (7) Make sure your patches apply against libvirt GIT. Developers only follow GIT
and don't care much about released versions. and don't care much about released versions.
(8) Run the automated tests on your code before submitting any changes. In (8) Run the automated tests on your code before submitting any changes. In
particular, configure with compile warnings set to -Werror. This is done particular, configure with compile warnings set to -Werror. This is done
automatically for a git checkout; from a tarball, use: automatically for a git checkout; from a tarball, use:
@ -163,8 +149,6 @@ the file is stored.
VIR_TEST_FILE_ACCESS=1 VIR_TEST_FILE_ACCESS_OUTPUT="/tmp/file_access.txt" ./qemuxml2argvtest VIR_TEST_FILE_ACCESS=1 VIR_TEST_FILE_ACCESS_OUTPUT="/tmp/file_access.txt" ./qemuxml2argvtest
(9) The Valgrind test should produce similar output to "make check". If the output (9) The Valgrind test should produce similar output to "make check". If the output
has traces within libvirt API's, then investigation is required in order to has traces within libvirt API's, then investigation is required in order to
determine the cause of the issue. Output such as the following indicates some determine the cause of the issue. Output such as the following indicates some
@ -239,15 +223,9 @@ to "tests/.valgrind.supp" in order to suppress the warning:
obj:*/lib*/ld-2.*so* obj:*/lib*/ld-2.*so*
} }
(10) Update tests and/or documentation, particularly if you are adding a new (10) Update tests and/or documentation, particularly if you are adding a new
feature or changing the output of a program. 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 Richard Jones' guide to working with open source projects on the subject, on Richard Jones' guide to working with open source projects
<http://people.redhat.com/rjones/how-to-supply-code-to-open-source-projects/>. <http://people.redhat.com/rjones/how-to-supply-code-to-open-source-projects/>.
@ -585,8 +563,6 @@ true) ...". Rather, write "if (seen)...".
Of course, take all of the above with a grain of salt. If you're about to use Of course, take all of the above with a grain of salt. If you're about to use
some system interface that requires a type like "size_t", "pid_t" or "off_t", some system interface that requires a type like "size_t", "pid_t" or "off_t",
use matching types for any corresponding variables. use matching types for any corresponding variables.
@ -698,8 +674,6 @@ size:
File handling File handling
============= =============
Usage of the "fdopen()", "close()", "fclose()" APIs is deprecated in libvirt Usage of the "fdopen()", "close()", "fclose()" APIs is deprecated in libvirt
@ -743,8 +717,6 @@ APIs, use the macros from virfile.h
String comparisons String comparisons
================== ==================
Do not use the strcmp, strncmp, etc functions directly. Instead use one of the Do not use the strcmp, strncmp, etc functions directly. Instead use one of the
@ -792,8 +764,6 @@ following semantically named macros
String copying String copying
============== ==============
Do not use the strncpy function. According to the man page, it does *not* Do not use the strncpy function. According to the man page, it does *not*
@ -962,8 +932,6 @@ by further potentially failing calls. You should almost certainly be using a
conditional and a block instead of a goto. Perhaps some of your function's conditional and a block instead of a goto. Perhaps some of your function's
logic would be better pulled out into a helper function. 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>

13
docs/hacking2.xsl
View File

@ -37,6 +37,8 @@ from docs/hacking.html.in!
<xsl:value-of select="normalize-space(.)"/> <xsl:value-of select="normalize-space(.)"/>
<xsl:text> <xsl:text>
</xsl:text>====================== </xsl:text>======================
</xsl:template> </xsl:template>
@ -93,20 +95,13 @@ from docs/hacking.html.in!
<xsl:template match="html:ol|html:ul|html:p"> <xsl:template match="html:p">
<xsl:apply-templates/><xsl:value-of select="$newline"/><xsl:value-of select="$newline"/> <xsl:apply-templates/><xsl:value-of select="$newline"/><xsl:value-of select="$newline"/>
</xsl:template> </xsl:template>
<xsl:template match="html:ol/html:li"> <xsl:template match="html:ol/html:li">(<xsl:value-of select="position()"/>) <xsl:apply-templates/>
<xsl:choose>
<xsl:when test=".//node()[position()=last()]/self::pre">(<xsl:value-of select="position()"/>) <xsl:apply-templates/>
</xsl:when>
<!-- only append two newlines when the last element isn't a pre element -->
<xsl:otherwise>(<xsl:value-of select="position()"/>) <xsl:apply-templates/><xsl:value-of select="$newline"/><xsl:value-of select="$newline"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template> </xsl:template>