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 /HACKING | |
| parent | 892242519acceec2b43d9b534acb468a99330cf4 (diff) | |
| download | libvirt-703832299190d088e3b71e1546864001d9bffb9d.tar.gz | |
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 'HACKING')
| -rw-r--r-- | HACKING | 22 |
1 files changed, 14 insertions, 8 deletions
@@ -1,5 +1,6 @@ -*- 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! @@ -32,11 +33,14 @@ Then, when you want to post your patches: git pull --rebase (fix any conflicts) - git send-email --cover-letter --no-chain-reply-to --annotate --to=libvir-list@redhat.com master + git send-email --cover-letter --no-chain-reply-to --annotate \ + --to=libvir-list@redhat.com master -For a single patch you can omit "--cover-letter", but series of a two or more -patches needs a cover letter. If you get tired of typing -"--to=libvir-list@redhat.com" designation you can set it in git config: +(Note that the "git send-email" subcommand is usually not in the main git +package, but part of a sub-package called "git-email".) For a single patch you +can omit "--cover-letter", but series of a two or more patches needs a cover +letter. If you get tired of typing "--to=libvir-list@redhat.com" designation +you can set it in git config: git config sendemail.to libvir-list@redhat.com @@ -56,9 +60,11 @@ though). (3) 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. +required to be able to compile cleanly (*including* "make check" and "make +syntax-check") 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 "git bisect", among other +things). |