config/advice.txt: fix description list separator
diff mbox series

Message ID 20200108200844.30803-1-martin.agren@gmail.com
State New
Headers show
Series
  • config/advice.txt: fix description list separator
Related show

Commit Message

Martin Ågren Jan. 8, 2020, 8:08 p.m. UTC
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(-)

Comments

Junio C Hamano Jan. 8, 2020, 9:16 p.m. UTC | #1
Martin Ågren <martin.agren@gmail.com> writes:

> 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.


>
>  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.
>  --

Patch
diff mbox series

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.
 --