threads / patch / 53825

patchgit-rebase.txt: fix description list separator

Subject: [PATCH] git-rebase.txt: fix description list separator

## tl;dr

2 messages between Jul 9, 2020 and Jul 9, 2020. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Martin Ågren· Jul 9, 2020, 18:24 UTC · lore

We don't give a "::" for the list separator, but just a single ":". This ends up rendering literally, "--apply: Use applying strategies ...". As a follow-on error, the list continuation, "+", also ends up rendering literally (because we don't have a list).

This was introduced in 52eb738d6b ("rebase: add an --am option", 2020-02-15) and survived the rename in 10cdb9f38a ("rebase: rename the two primary rebase backends", 2020-02-15).

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 See, e.g., https://git-scm.com/docs/git-rebase/en#Documentation/git-rebase.txt---quit
 Documentation/git-rebase.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-rebase.txt +1 −0
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index f7a6033607..9acea055d7 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -258,7 +258,7 @@ See also INCOMPATIBLE OPTIONS below.
 	original branch. The index and working tree are also left
 	unchanged as a result.
 
---apply:
+--apply::
 	Use applying strategies to rebase (calling `git-am`
 	internally).  This option may become a no-op in the future
 	once the merge backend handles everything the apply one does.
-- 
2.27.0
Junio C Hamano· Jul 9, 2020, 18:36 UTC · re: Martin Ågren · lore

Re: [PATCH] git-rebase.txt: fix description list separator

Martin Ågren <martin.agren@gmail.com> writes:
Show 26 quoted lines
> We don't give a "::" for the list separator, but just a single ":". This
> ends up rendering literally, "--apply: Use applying strategies ...". As
> a follow-on error, the list continuation, "+", also ends up rendering
> literally (because we don't have a list).
>
> This was introduced in 52eb738d6b ("rebase: add an --am option",
> 2020-02-15) and survived the rename in 10cdb9f38a ("rebase: rename the
> two primary rebase backends", 2020-02-15).
>
> Signed-off-by: Martin Ågren <martin.agren@gmail.com>
> ---
>  See, e.g., https://git-scm.com/docs/git-rebase/en#Documentation/git-rebase.txt---quit
>
>  Documentation/git-rebase.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index f7a6033607..9acea055d7 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -258,7 +258,7 @@ See also INCOMPATIBLE OPTIONS below.
>  	original branch. The index and working tree are also left
>  	unchanged as a result.
>  
> ---apply:
> +--apply::
Obviously correct.  Thanks.
>  	Use applying strategies to rebase (calling `git-am`
>  	internally).  This option may become a no-op in the future
>  	once the merge backend handles everything the apply one does.

← back to recent threads