All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "erik chen via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH v3 0/1] fetch: add trace2 instrumentation
Date: Thu, 07 Nov 2019 14:21:25 +0900	[thread overview]
Message-ID: <xmqqd0e4s1m2.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <pull.451.v3.git.1573069152.gitgitgadget@gmail.com> (erik chen via GitGitGadget's message of "Wed, 06 Nov 2019 19:39:11 +0000")

"erik chen via GitGitGadget" <gitgitgadget@gmail.com> writes:

> Add trace2 regions to fetch-pack.c to better track time spent in the various
> phases of a fetch:
>
> * matching common remote and local refs
> * marking local refs as complete (part of the matching process)
>
> Both of these stages can be slow for repositories with many refs.
>
> Signed-off-by: Erik Chen erikchen@chromium.org [erikchen@chromium.org]

If the above is verbatim copy of what you wrote in 1/1, that is very
much unappreciated X-<.  A cover letter for a topic serves primarily
just one purpose:

   It is a good place to present a birds-eye-view of a multi-patch
   topic; a high level description of the problem (e.g. how the
   issue manifests to the end users), an explanation of division of
   the problem into subproblems you made (if applicable), and
   interesting highlights of the solution would all be good things
   to have in there.

And as a topic goes through iterations, it gives you a good place to
summarize what changed since the previously reviewed iterations.  It
could be just a single liner "addressed all the review comments for
the previous iteration".  A well-written multi-patch topic also uses
the same after-three-dash technique used for a single-patch topic
(see below) to summarize what changed since the corresponding patch
in the series in the previous iteration (or just says "no changes
since the previous round"---that helps the reviewers a lot).
   
For a single-patch topic, there is no place for "here is an overall
birds-eyes-view picture because the changes described in the
proposed log message of individual patches are so big and complex".
A single-patch topic has one patch, that solves one problem and only
that problem well, so it should not need such a summary.  

When you want to summarize the changes since the previous iteration,
you would write it between the three-dash-line (which appears after
your sign-off) and the diffstat.

Thanks.

  parent reply	other threads:[~2019-11-07  5:21 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-05 19:26 [PATCH 0/1] fetch: add trace2 instrumentation erik chen via GitGitGadget
2019-11-05 19:26 ` [PATCH 1/1] " Erik Chen via GitGitGadget
2019-11-06 12:30   ` Johannes Schindelin
2019-11-06 18:51 ` [PATCH v2 0/2] " erik chen via GitGitGadget
2019-11-06 18:51   ` [PATCH v2 1/2] " Erik Chen via GitGitGadget
2019-11-06 18:51   ` [PATCH v2 2/2] add whitespace Erik Chen via GitGitGadget
2019-11-06 19:39   ` [PATCH v3 0/1] fetch: add trace2 instrumentation erik chen via GitGitGadget
2019-11-06 19:39     ` [PATCH v3 1/1] " Erik Chen via GitGitGadget
2019-11-07  5:32       ` Junio C Hamano
2019-11-18 15:46         ` Derrick Stolee
2019-11-19  1:55           ` Junio C Hamano
2019-11-19 21:24             ` Erik Chen
2019-11-19 22:57             ` Erik Chen
2019-11-19 21:51           ` Erik Chen
2019-11-19 21:47         ` Erik Chen
2019-11-07  5:21     ` Junio C Hamano [this message]
2019-11-19 21:44       ` [PATCH v3 0/1] " Erik Chen
2019-11-18 14:52     ` [PATCH v4 " erik chen via GitGitGadget
2019-11-18 14:52       ` [PATCH v4 1/1] " Erik Chen via GitGitGadget
2019-11-19 23:02       ` [PATCH v5 0/1] " erik chen via GitGitGadget
2019-11-19 23:02         ` [PATCH v5 1/1] " Erik Chen via GitGitGadget
2019-11-20  1:07           ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqd0e4s1m2.fsf@gitster-ct.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.