Skip to contentSkip to conversation

config/advice.txt: fix description list separator

PATCH In review Martin Ågren 2 participants 2 messages Jan 8, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 config/advice.txt: fix description list separator

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.

---
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(-)
Documentation/config/advice.txt +1 -1
index d4e698cd3f..4be93f8ad9 100644
@@ -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.
 --
Signature · 1 line
2.25.0.rc1.19.g042ed3e048
#1 lore raw
Quoted 5 lines · Martin Ågren

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.

Quoted 8 lines

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

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

Quoted 17 lines
 Documentation/config/advice.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/advice.txt +1 -1
index d4e698cd3f..4be93f8ad9 100644
@@ -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.
 --