diff options
| author |   Laine Stump <laine@laine.org> | 2012-09-06 13:21:21 -0400 |
|---|---|---|
| committer | Laine Stump <laine@laine.org> | 2012-09-08 23:20:29 -0400 |
| commit | 703832299190d088e3b71e1546864001d9bffb9d (patch) | |
| tree | 7d40113e54e5c28707b2b4ae336d932a09c0d75d /docs | |
| parent | build: fix build on older gcc (diff) | |
| download | libvirt-703832299190d088e3b71e1546864001d9bffb9d.tar.gz libvirt-703832299190d088e3b71e1546864001d9bffb9d.tar.bz2 libvirt-703832299190d088e3b71e1546864001d9bffb9d.zip | |
docs: point out git send-email location, be more stern about make check
An email came to libvir-list wondering why the git send-email command
was missing in spite of having git installed; this is due to the
send-email command being in a sub-package of the main git package.
While touching the hacking file, I thought it would be useful to 1)
indicate the location of the source (docs/hacking.html.in) in the
message at the top of HACKING, and also to make the note about running
"make check" and "make syntax-check" a bit more stern.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hacking.html.in | 30 | ||||
| -rw-r--r-- | docs/hacking2.xsl | 3 |
2 files changed, 21 insertions, 12 deletions
diff --git a/docs/hacking.html.in b/docs/hacking.html.in index ca0266905..eb799532c 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -31,11 +31,16 @@ <pre> git pull --rebase (fix any conflicts) - git send-email --cover-letter --no-chain-reply-to --annotate --to=libvir-list@redhat.com master -</pre> - <p>For a single patch you can omit <code>--cover-letter</code>, but - series of a two or more patches needs a cover letter. If you get tired - of typing <code>--to=libvir-list@redhat.com</code> designation you can + git send-email --cover-letter --no-chain-reply-to --annotate \ + --to=libvir-list@redhat.com master +</pre> + <p>(Note that the "git send-email" subcommand may not be in + the main git package and using it may require installion of a + separate package, for example the "git-email" package in + Fedora.) For a single patch you can omit + <code>--cover-letter</code>, but a series of two or more + patches needs a cover letter. If you get tired of typing + <code>--to=libvir-list@redhat.com</code> designation you can set it in git config:</p> <pre> git config sendemail.to libvir-list@redhat.com @@ -55,12 +60,15 @@ </li> <li><p>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 sequence of patches fits together. Moreover, - please keep in mind that it's required to be able to compile cleanly - after each patch. A feature does not have to work until the end of a - series, as long as intermediate patches don't cause test-suite - failures.</p> + self-contained if 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 required to + be able to compile cleanly (<b>including</b> <code>make + check</code> and <code>make syntax-check</code>) after each + patch. A feature does not have to work until the end of a + series, but intermediate patches must compile and not cause + test-suite failures (this is to preserve the usefulness + of <code>git bisect</code>, among other things).</p> </li> <li>Make sure your patches apply against libvirt GIT. Developers diff --git a/docs/hacking2.xsl b/docs/hacking2.xsl index 89e777b0e..cd1712c05 100644 --- a/docs/hacking2.xsl +++ b/docs/hacking2.xsl @@ -18,7 +18,8 @@ <xsl:template match="/"> <xsl:text>-*- buffer-read-only: t -*- vi: set ro: -DO NOT EDIT THIS FILE! IT IS GENERATED AUTOMATICALLY! +DO NOT EDIT THIS FILE! IT IS GENERATED AUTOMATICALLY +from docs/hacking.html.in! |