Re: [PATCH] rebase: Fix documentation about used shell in -x

From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Date: Jan 16, 2024, 16:50 UTC
Message-ID: <b491d954-b1a4-4000-95fb-fc83bf815edc@app.fastmail.com>
In-Reply-To: <20240116141842.193151-1-nik.borisov@suse.com>

Hi

Some nitpicks since it seems like there will be another round (v2):

> rebase: Fix documentation about used shell in -x

Lower-case “fix” is more conventional.[1]

> SHELL_PATH constant at build time. This erroneous statement in the
> documentation sent me on a 10 minute wild goose chase wondering why my
> $SHELL was pointing to /bin/bash and my /bin/sh to dash and git was
> using dash and not bash.

I think anecdotes are not kept in the commit message, usually? Often they are put after the three-hyphen/three-dash line. But I didn’t manage to find any email that says that.

    The shell used when using the -x option is the one pointed to by the
    SHELL_PATH constant at build time.

    Signed-off-by: Nikolay Borisov <nik.borisov@suse.com>
    ---
      This erroneous statement in the documentation sent me on a 10 minute
      wild goose chase wondering why my $SHELL was pointing to /bin/bash and
      my /bin/sh to dash and git was using dash and not bash.

     Documentation/git-rebase.txt | 2 +-
     1 file changed, 1 insertion(+), 1 deletion(-)

† 1: SubmittingPatches:

  “ [[summary-section]]
    The title sentence after the "area:" prefix omits the full stop at the
    end, and its first word is not capitalized (the omission
    of capitalization applies only to the word after the "area:"
    prefix of the title)

-- 
Kristoffer Haugsbakk