Re: [PATCHv4 5/7] builtin/describe.c: print debug statements earlier

From: Jonathan Tan <jonathantanmy@google.com>
Date: Nov 15, 2017, 01:41 UTC
Message-ID: <20171114174134.51c5a41788ecb5675b8d93f8@google.com>
In-Reply-To: <20171115003043.24080-6-sbeller@google.com>

On Tue, 14 Nov 2017 16:30:41 -0800 Stefan Beller <sbeller@google.com> wrote:

Show 11 quoted lines

> For debuggers aid we'd want to print debug statements early, so
> introduce a new line in the debug output that describes the whole
> function, and then change the next debug output to describe why we
> need to search. Conveniently drop the arg from the second line;
> which will be useful in a follow up commit, that refactors the
> describe function.
> 
> This re-arrangement of debug printing is solely done for a better
> refactoring in the next commit, not to aid debugging git-describe,
> which is expected to have the same information readily available
> with the new prints.

This paragraph ("not to aid debugging") contradicts the previous one ("For debuggers aid").

Looking at this patch and the subsequent patches, I would write the commit message like this:

    When debugging, print the received argument at the start of the
    function instead of in the middle. This ensures that the received
    argument is printed in all code paths, and also allows a subsequent
    refactoring to not need to move the "arg" parameter.

Also change the title to "print arg earlier when debugging" or something like that.