threads / patch / 60981

patchDocumentation/config/pack.txt: fix broken AsciiDoc

Subject: [PATCH] Documentation/config/pack.txt: fix broken AsciiDoc

## tl;dr

2 messages between Feb 23, 2024 and Feb 23, 2024. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Taylor Blau· Feb 23, 2024, 20:30 UTC · lore

In af626ac0e0 (pack-bitmap: enable reuse from all bitmapped packs, 2023-12-14), the documentation for `pack.allowPackReuse` was amended to include its effect when set to "multi".

This split the documentation into two paragraphs, but did not de-dent the second paragraph on the right-hand side of a line-continuation marker. This causes the rendered documentation to appear oddly, where the second paragraph is treated as a <pre> block when rendered as HTML.

Fix this by correctly removing the indentation on the second paragraph.
Signed-off-by: Taylor Blau <me@ttaylorr.com>
---
 Documentation/config/pack.txt | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
Show changes to Documentation/config/pack.txt +4 −5
diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.txt
index 9c630863e6..da527377fa 100644
--- a/Documentation/config/pack.txt
+++ b/Documentation/config/pack.txt
@@ -34,11 +34,10 @@ pack.allowPackReuse::
 	reachability bitmap is available, pack-objects will try to send
 	parts of all packs in the MIDX.
 +
-	If only a single pack bitmap is available, and
-	`pack.allowPackReuse` is set to "multi", reuse parts of just the
-	bitmapped packfile. This can reduce memory and CPU usage to
-	serve fetches, but might result in sending a slightly larger
-	pack. Defaults to true.
+If only a single pack bitmap is available, and `pack.allowPackReuse`
+is set to "multi", reuse parts of just the bitmapped packfile. This
+can reduce memory and CPU usage to serve fetches, but might result in
+sending a slightly larger pack. Defaults to true.
 
 pack.island::
 	An extended regular expression configuring a set of delta
-- 
2.44.0.rc2.25.g54c9b1361db
Junio C Hamano· Feb 23, 2024, 22:15 UTC · re: Taylor Blau · lore

Re: [PATCH] Documentation/config/pack.txt: fix broken AsciiDoc

Taylor Blau <me@ttaylorr.com> writes:
Show 17 quoted lines
> diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.txt
> index 9c630863e6..da527377fa 100644
> --- a/Documentation/config/pack.txt
> +++ b/Documentation/config/pack.txt
> @@ -34,11 +34,10 @@ pack.allowPackReuse::
>  	reachability bitmap is available, pack-objects will try to send
>  	parts of all packs in the MIDX.
>  +
> -	If only a single pack bitmap is available, and
> -	`pack.allowPackReuse` is set to "multi", reuse parts of just the
> -	bitmapped packfile. This can reduce memory and CPU usage to
> -	serve fetches, but might result in sending a slightly larger
> -	pack. Defaults to true.
> +If only a single pack bitmap is available, and `pack.allowPackReuse`
> +is set to "multi", reuse parts of just the bitmapped packfile. This
> +can reduce memory and CPU usage to serve fetches, but might result in
> +sending a slightly larger pack. Defaults to true.
Thanks.

← back to recent threads