threads / patch / 48317

patchdocs/git-gc: fix minor rendering issue

Subject: [PATCH] docs/git-gc: fix minor rendering issue

## tl;dr

2 messages between Apr 17, 2018 and Apr 18, 2018. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

SZEDER Gábor· Apr 17, 2018, 21:36 UTC · lore

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.

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
---
 Documentation/git-gc.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/git-gc.txt +1 −1

diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 3126e0dd00..7c8a2edd48 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -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`

-- 
2.17.0.366.gbe216a3084

Junio C Hamano· Apr 18, 2018, 03:06 UTC · re: SZEDER Gábor · lore

Re: [PATCH] docs/git-gc: fix minor rendering issue

SZEDER Gábor <szeder.dev@gmail.com> writes:

Show 26 quoted lines

> 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.
>
> Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
> ---
>  Documentation/git-gc.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
> index 3126e0dd00..7c8a2edd48 100644
> --- a/Documentation/git-gc.txt
> +++ b/Documentation/git-gc.txt
> @@ -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.