git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: Taylor Blau <me@ttaylorr.com>
Subject: [PATCH] Documentation/gitpacking: make sample configs listing blocks
Date: Wed, 17 Jul 2024 12:54:28 +0200	[thread overview]
Message-ID: <20240717105432.2801097-1-martin.agren@gmail.com> (raw)

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 <martin.agren@gmail.com>
---
 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(-)

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",
-- 
2.46.0.rc0.321.g44c27ab58a


             reply	other threads:[~2024-07-17 10:54 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-17 10:54 Martin Ågren [this message]
2024-07-17 15:48 ` [PATCH] Documentation/gitpacking: make sample configs listing blocks Junio C Hamano
2024-07-18 22:51 ` Taylor Blau

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240717105432.2801097-1-martin.agren@gmail.com \
    --to=martin.agren@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=me@ttaylorr.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).