Re: [PATCHv2] Documentation/SubmittingPatches: Explain the rationale of git notes
On Mon, Dec 29, 2014 at 12:42 PM, Stefan Beller <sbeller@google.com> wrote:
Show 20 quoted lines
> This adds more explanation of why you want to have the --notes option
> given to git format-patch.
>
> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index e3c942e..f42c607 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -177,7 +177,12 @@ message starts, you can put a "From: " line to name that person.
> You often want to add additional explanation about the patch,
> other than the commit message itself. Place such "cover letter"
> material between the three dash lines and the diffstat. Git-notes
> -can also be inserted using the `--notes` option.
> +can also be inserted using the `--notes` option. If you are one
> +of those developers who cannot write perfect code the first time
> +and need multiple iterations of review and discussion, you may
> +want to keep track of the changes between different versions of
> +a patch using notes and then also use the `--notes` option when
> +preparing the patch for submission.
Perhaps this could be rephrased in a less derogatory fashion like this:
...material between the three dash line and the diffstat.
For patches requiring multiple iterations of review and
discussion, an explanation of changes between each iteration can
be kept in Git-notes and inserted automatically following the
three dash line via `git format-patch --notes`.> Do not attach the patch as a MIME attachment, compressed or not.
> Do not let your e-mail client send quoted-printable. Do not let
> --
> 2.2.1.62.g3f15098
Eric Sunshine <sunshine@sunshineco.com>