git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] Documentation/git-merge: at least one <remote> not two

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 1, 2009, 21:25 UTC
Message-ID
<7vk59ehg7l.fsf@gitster.siamese.dyndns.org>
In-Reply-To
<87d4f6vph7.fsf@jidanni.org>
jidanni@jidanni.org writes:
Show 18 quoted lines
> Make SYNOPSIS match usage message
>
> Signed-off-by: jidanni <jidanni@jidanni.org>
> ---
>  Documentation/git-merge.txt |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
>
> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
> index f7be584..a3ac828 100644
> --- a/Documentation/git-merge.txt
> +++ b/Documentation/git-merge.txt
> @@ -10,7 +10,7 @@ SYNOPSIS
>  --------
>  [verse]
>  'git merge' [-n] [--stat] [--no-commit] [--squash] [-s <strategy>]...
> -	[-m <msg>] <remote> <remote>...
> +	[-m <msg>] <remote>...
>  'git merge' <msg> HEAD <remote>...

The original uses ellipses for the first-class UI syntax as "zero or more", while it means "one or more" in the description for the original syntax, which is inconsistent, and you are matching them by making both use "one or more" interpretation.

Two issues:
 * Are there similar breakages like this in the documentation and the
   usage text?  It would be a good idea to make the ellipses to mean the
   same thing everywhere, and a janitorial patch series that would fix
   the "ellipses" breakage (and nothing else) may be a good thing to
   have.  But before going that route...
 * Is it a good idea to standardize on "one or more" semantics?  I suspect
   we would rather want to standardize on "zero or more", because it would
   be more natural to say:
    $ git diff [--] <paths>...
   to mean "You can give paths if you want to but you do not have to".  If
   ellipses meant "one or more", you have to say this instead:
    $ git diff [--] [<paths>...]

While I prefer "zero or more" because I think it is more logical, if the preparatory study for the first issue reveals that we use "one or more" a lot more often, it might be easier to standardize on that interpretation.

Oh, you also need to give ellipses to the usage string for the original syntax in builtin-merge.c to match SYNOPSIS and usage string.

Thanks.
Previous: jidanni@jidanni.orgNext: Sitaram Chamarty
Message 2 of 3 in “Documentation/git-merge: at least one <remote> not two”
  1. Documentation/git-merge: at least one <remote> not twojidanni@jidanni.org, Jan 1, 2009
  2. Junio C HamanoJan 1, 2009
  3. Sitaram ChamartyJan 2, 2009

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.