threads / patch / 52595

patchconfig/advice.txt: fix description list separator

Subject: [PATCH] config/advice.txt: fix description list separator

## tl;dr

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

replies: 1people: 2as markdown or json

Martin Ågren· Jan 8, 2020, 20:08 UTC · lore

The whole submoduleAlternateErrorStrategyDie item is interpreted as being part of the supporting content of the preceding item. This is because we don't give a double-colon "::" for the separator, but just a single colon, ":". Let's fix that.

There are a few other matches for [^:]:\s*$ in Documentation/config, but I didn't spot any similar bugs among them.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 This was the only thing that stood out at me while going through
 `./doc-diff v2.24.0 origin/master`. This is obviously a non-critical,
 purely cosmetic issue.
 Documentation/config/advice.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/config/advice.txt +1 −1
diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt
index d4e698cd3f..4be93f8ad9 100644
--- a/Documentation/config/advice.txt
+++ b/Documentation/config/advice.txt
@@ -107,7 +107,7 @@ advice.*::
 		editor input from the user.
 	nestedTag::
 		Advice shown if a user attempts to recursively tag a tag object.
-	submoduleAlternateErrorStrategyDie:
+	submoduleAlternateErrorStrategyDie::
 		Advice shown when a submodule.alternateErrorStrategy option
 		configured to "die" causes a fatal error.
 --

-- 
2.25.0.rc1.19.g042ed3e048
Junio C Hamano· Jan 8, 2020, 21:16 UTC · re: Martin Ågren · lore

Re: [PATCH] config/advice.txt: fix description list separator

Martin Ågren <martin.agren@gmail.com> writes:
Show 13 quoted lines
> The whole submoduleAlternateErrorStrategyDie item is interpreted as
> being part of the supporting content of the preceding item. This is
> because we don't give a double-colon "::" for the separator, but just a
> single colon, ":". Let's fix that.
>
> There are a few other matches for [^:]:\s*$ in Documentation/config, but
> I didn't spot any similar bugs among them.
>
> Signed-off-by: Martin Ågren <martin.agren@gmail.com>
> ---
>  This was the only thing that stood out at me while going through
>  `./doc-diff v2.24.0 origin/master`. This is obviously a non-critical,
>  purely cosmetic issue.

Thanks. It still is a new bug introduced by a recent change, so I am tempted to include it in the final but it is a bit too late for the -rc2 I planned to tag today.

Show 17 quoted lines
>
>  Documentation/config/advice.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt
> index d4e698cd3f..4be93f8ad9 100644
> --- a/Documentation/config/advice.txt
> +++ b/Documentation/config/advice.txt
> @@ -107,7 +107,7 @@ advice.*::
>  		editor input from the user.
>  	nestedTag::
>  		Advice shown if a user attempts to recursively tag a tag object.
> -	submoduleAlternateErrorStrategyDie:
> +	submoduleAlternateErrorStrategyDie::
>  		Advice shown when a submodule.alternateErrorStrategy option
>  		configured to "die" causes a fatal error.
>  --

← back to recent threads