Skip to contentSkip to conversation

docs/git-gc: fix minor rendering issue

PATCH In review SZEDER Gábor 2 participants 2 messages Apr 17, 2018 – Apr 18, 2018 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/git-gc: fix minor rendering issue

An unwanted single quote character in the paragraph documenting the 'gc.aggressiveWindow' config variable prevented the name of that config variable from being rendered correctly, ever since that piece of docs was added in 0d7566a5ba (Add --aggressive option to 'git gc', 2007-05-09).

Remove that single quote.

---
 Documentation/git-gc.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-gc.txt +1 -1
index 3126e0dd00..7c8a2edd48 100644
@@ -129,7 +129,7 @@ The optional configuration variable `gc.aggressiveWindow` controls how
 much time is spent optimizing the delta compression of the objects in
 the repository when the --aggressive option is specified.  The larger
 the value, the more time is spent optimizing the delta compression.  See
-the documentation for the --window' option in linkgit:git-repack[1] for
+the documentation for the --window option in linkgit:git-repack[1] for
 more details.  This defaults to 250.
 
 Similarly, the optional configuration variable `gc.aggressiveDepth`
Signature · 1 line
2.17.0.366.gbe216a3084
#1 lore raw
Quoted 18 lines · SZEDER Gábor

An unwanted single quote character in the paragraph documenting the 'gc.aggressiveWindow' config variable prevented the name of that config variable from being rendered correctly, ever since that piece of docs was added in 0d7566a5ba (Add --aggressive option to 'git gc', 2007-05-09).

Remove that single quote.

---
 Documentation/git-gc.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-gc.txt +0 -0
index 3126e0dd00..7c8a2edd48 100644

Documentation/git-gc.txt The optional configuration variable `gc.aggressiveWindow` controls how · line 135

Quoted 8 lines
Documentation/git-gc.txt +1 -1
@@ -129,7 +129,7 @@ The optional configuration variable `gc.aggressiveWindow` controls how
 much time is spent optimizing the delta compression of the objects in
 the repository when the --aggressive option is specified.  The larger
 the value, the more time is spent optimizing the delta compression.  See
-the documentation for the --window' option in linkgit:git-repack[1] for
+the documentation for the --window option in linkgit:git-repack[1] for
 more details.  This defaults to 250.
 
 Similarly, the optional configuration variable `gc.aggressiveDepth`

Thanks, will queue. We might want to monospace quote these options that are to be literally typed by the users, but that is better left to another patch.