Documentation/gitpacking: make sample configs listing blocks

Commit Message

Martin Ågren July 17, 2024, 10:54 a.m. UTC

This document contains a few sample config snippets. At least with
Asciidoctor, the section headers are rendered *more* indented than the
variables that follow:

       [bitmapPseudoMerge "all"]
    pattern = "refs/"
    ...

To address this, wrap these listings in AsciiDoc listing blocks. Remove
the indentation from the section headings. This is similar to how we
handle such sample config elsewhere, e.g., in config.txt.

While we're here, fix the nearby "wiht" typo.

Signed-off-by: Martin Ågren <[e-mail]>
---
 These buglets were introduced in faf558b23e (pseudo-merge: implement
 support for selecting pseudo-merge commits, 2024-05-23) as part of 
 tb/pseudo-merge-reachability-bitmap.

 Documentation/gitpacking.txt | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

Comments

Junio C Hamano July 17, 2024, 3:48 p.m. UTC | #1

Martin Ågren <[e-mail]> writes:

> To address this, wrap these listings in AsciiDoc listing blocks. Remove
> the indentation from the section headings. This is similar to how we
> handle such sample config elsewhere, e.g., in config.txt.
>
> While we're here, fix the nearby "wiht" typo.
>
> Signed-off-by: Martin Ågren <[e-mail]>
> ---
>  These buglets were introduced in faf558b23e (pseudo-merge: implement
>  support for selecting pseudo-merge commits, 2024-05-23) as part of 
>  tb/pseudo-merge-reachability-bitmap.

Thanks, will queue.

Taylor Blau July 18, 2024, 10:51 p.m. UTC | #2

Hi Martin,

On Wed, Jul 17, 2024 at 12:54:28PM +0200, Martin Ågren wrote:
> ---
>  These buglets were introduced in faf558b23e (pseudo-merge: implement
>  support for selecting pseudo-merge commits, 2024-05-23) as part of
>  tb/pseudo-merge-reachability-bitmap.
>
>  Documentation/gitpacking.txt | 14 ++++++++++----
>  1 file changed, 10 insertions(+), 4 deletions(-)

Oops. Thank you for finding and fixing, it is much appreciated.

Thanks,
Taylor

Patch

diff --git a/Documentation/gitpacking.txt b/Documentation/gitpacking.txt
index 4a6fcba6f7..321154d4e6 100644
--- a/Documentation/gitpacking.txt
+++ b/Documentation/gitpacking.txt
@@ -143,14 +143,16 @@  include::config/bitmap-pseudo-merge.txt[]
 Suppose that you have a repository with a large number of references,
 and you want a bare-bones configuration of pseudo-merge bitmaps that
 will enhance bitmap coverage of the `refs/` namespace. You may start
-wiht a configuration like so:
+with a configuration like so:
 
-    [bitmapPseudoMerge "all"]
+----
+[bitmapPseudoMerge "all"]
 	pattern = "refs/"
 	threshold = now
 	stableThreshold = never
 	sampleRate = 100
 	maxMerges = 64
+----
 
 This will create pseudo-merge bitmaps for all references, regardless of
 their age, and group them into 64 pseudo-merge commits.
@@ -159,8 +161,10 @@  If you wanted to separate tags from branches when generating
 pseudo-merge commits, you would instead define the pattern with a
 capture group, like so:
 
-    [bitmapPseudoMerge "all"]
+----
+[bitmapPseudoMerge "all"]
 	pattern = "refs/(heads/tags)/"
+----
 
 Suppose instead that you are working in a fork-network repository, with
 each fork specified by some numeric ID, and whose refs reside in
@@ -168,12 +172,14 @@  each fork specified by some numeric ID, and whose refs reside in
 fork) in the network. In this instance, you may instead write something
 like:
 
-    [bitmapPseudoMerge "all"]
+----
+[bitmapPseudoMerge "all"]
 	pattern = "refs/virtual/([0-9]+)/(heads|tags)/"
 	threshold = now
 	stableThreshold = never
 	sampleRate = 100
 	maxMerges = 64
+----
 
 Which would generate pseudo-merge group identifiers like "1234-heads",
 and "5678-tags" (for branches in fork "1234", and tags in remote "5678",