Re: Bug | Documentation | git add -all | Synopsis has minor mistake

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Dec 15, 2023, 20:49 UTC
Message-ID: <CAPig+cSkzJpufEG_XhFdSho89itLOuvCwMaTkXXAjryNnWteQQ@mail.gmail.com>
In-Reply-To: <CAM=w4Pn46nTcWA1e=n4Rms76gCx7iqbRmOWf3=vRmKgtbhqQmA@mail.gmail.com>

On Fri, Dec 15, 2023 at 7:38 AM Benjamin Lehmann <ben.lehmann@gmail.com> wrote:

Show 10 quoted lines

> The mistake can be found in the synopsis here:
> https://git-scm.com/docs/git-add#Documentation/git-add.txt--A
>
> In the synopsys, the options -all currently reads:
>
> [--[no-]all | --[no-]ignore-removal |
>
> You can see that there is no mention of -A, which is the main way that
> people would use -all perhaps, so it really ought to be included
> correctly in the synopsis.

This seems to be a simple oversight when the --all option was added by da98053aa6 (git-add --all: documentation, 2008-07-19).

> In addition, the closing square-bracket is missing.

I think this is inaccurate. If you look closely, you will find the closing bracket after the -u option:

    [--[no-]all | --[no-]ignore-removal | [--update | -u]]

meaning that --all, --ignore-removal, and --update are mutually exclusive.

> Hope this was the right place to report this - seemed to be the only option.

This is the correct place. I posted a patch[1] addressing the issue.

[1]: https://lore.kernel.org/git/20231215204333.1253-1-ericsunshine@charter.net/