[PATCH] doc: Make asciidoc bullet items separate

Subsystems: documentation, the rest

WARM2d

4 messages, 3 authors, 2d ago · open the first message on its own page

[PATCH] doc: Make asciidoc bullet items separate

From: Brigham Campbell <hidden>
Date: 2026-09-07 07:17:43

Fix conjoined bullet items in maintenance asciidoc file.

Signed-off-by: Brigham Campbell <redacted>
---
 Documentation/config/maintenance.adoc | 1 +
 1 file changed, 1 insertion(+)
diff --git a/Documentation/config/maintenance.adoc b/Documentation/config/maintenance.adoc
index da8be9f812..c778ab09ac 100644
--- a/Documentation/config/maintenance.adoc
+++ b/Documentation/config/maintenance.adoc
@@ -41,6 +41,7 @@ The possible strategies are:
 This repacking strategy is a full replacement for the `gc` strategy and is
 recommended for large repositories. This is the default strategy for manual
 maintenance.
++
 * `incremental`: This setting optimizes for performing small maintenance
   activities that do not delete any data. This does not schedule the `gc`
   task, but runs the `prefetch` and `commit-graph` tasks hourly, the
---
base-commit: 3cb9185f65410273787f74333cc027d2ea5daada
change-id: 20260907-maintenance-doc-bullet-fix-d351253f8a91

Thanks!
-- 
Brigham Campbell
https://brighamcampbell.com

Re: [PATCH] doc: Make asciidoc bullet items separate

From: Patrick Steinhardt <hidden>
Date: 2026-09-07 08:46:14

On Mon, Sep 07, 2026 at 01:15:57AM -0600, Brigham Campbell wrote:
Fix conjoined bullet items in maintenance asciidoc file.
Not, probably not worth a reroll: it would have been nice to point out
that this is in git-config(1). E.g. something like this:

    doc: fix conjoined maintenance strategies in git-config(1)

    Fix conjoined bullet items for the maintennace strategies in
    git-config(1).
quoted hunk
diff --git a/Documentation/config/maintenance.adoc b/Documentation/config/maintenance.adoc
index da8be9f812..c778ab09ac 100644
--- a/Documentation/config/maintenance.adoc
+++ b/Documentation/config/maintenance.adoc
@@ -41,6 +41,7 @@ The possible strategies are:
 This repacking strategy is a full replacement for the `gc` strategy and is
 recommended for large repositories. This is the default strategy for manual
 maintenance.
++
 * `incremental`: This setting optimizes for performing small maintenance
   activities that do not delete any data. This does not schedule the `gc`
   task, but runs the `prefetch` and `commit-graph` tasks hourly, the
Ah, indeed. I can confirm that this is misrendered when looking at
git-config(1), and with your patch it indeed renders correctly. Thanks
for this simple and obvious fix!

Patrick

Re: [PATCH] doc: Make asciidoc bullet items separate

From: Kristoffer Haugsbakk <hidden>
Date: 2026-09-07 10:19:12

On Mon, Sep 7, 2026, at 09:15, Brigham Campbell wrote:
quoted hunk
Fix conjoined bullet items in maintenance asciidoc file.

Signed-off-by: Brigham Campbell <redacted>
---
 Documentation/config/maintenance.adoc | 1 +
 1 file changed, 1 insertion(+)
diff --git a/Documentation/config/maintenance.adoc
b/Documentation/config/maintenance.adoc
index da8be9f812..c778ab09ac 100644
--- a/Documentation/config/maintenance.adoc
+++ b/Documentation/config/maintenance.adoc
@@ -41,6 +41,7 @@ The possible strategies are:
 This repacking strategy is a full replacement for the `gc` strategy
and is
 recommended for large repositories. This is the default strategy for
manual
 maintenance.
++
 * `incremental`: This setting optimizes for performing small
maintenance
   activities that do not delete any data. This does not schedule the
`gc`
   task, but runs the `prefetch` and `commit-graph` tasks hourly, the

---
base-commit: 3cb9185f65410273787f74333cc027d2ea5daada
change-id: 20260907-maintenance-doc-bullet-fix-d351253f8a91
I wonder if this gives different results for asciidoc and asciidoctor.

• asciidoctor: seems that the bullet list is correct with or without
  this change (no change)
• asciidoc: needs this change

Note that I’ve made enough asciidoc/tor mistakes so I’m not that
reliable of a witness.

I also idly wonder why git-scm renders this bullet list as it ought
to. This hunk has not been modified for a while. The second paragraph
which ostensibly made it conjoined was d9bccf2e (builtin/maintenance:
introduce "geometric" strategy, 2025-10-24).

https://git-scm.com/docs/git-config

Re: [PATCH] doc: Make asciidoc bullet items separate

From: Brigham Campbell <hidden>
Date: 2026-09-07 17:10:17

On Mon Sep 7, 2026 at 2:46 AM MDT, Patrick Steinhardt wrote:
Not, probably not worth a reroll: it would have been nice to point out
that this is in git-config(1). E.g. something like this:

    doc: fix conjoined maintenance strategies in git-config(1)

    Fix conjoined bullet items for the maintennace
maintennace -> maintenance
                                                   strategies in
    git-config(1).
I'll mention git-config(1) in v2 if maintainers request a new revision
(though I agree that a patch this simple probably doesn't need a
reroll). Otherwise, I invite the committer to make editorial changes to
the commit message as they see fit.
quoted
diff --git a/Documentation/config/maintenance.adoc b/Documentation/config/maintenance.adoc
index da8be9f812..c778ab09ac 100644
--- a/Documentation/config/maintenance.adoc
+++ b/Documentation/config/maintenance.adoc
@@ -41,6 +41,7 @@ The possible strategies are:
 This repacking strategy is a full replacement for the `gc` strategy and is
 recommended for large repositories. This is the default strategy for manual
 maintenance.
++
 * `incremental`: This setting optimizes for performing small maintenance
   activities that do not delete any data. This does not schedule the `gc`
   task, but runs the `prefetch` and `commit-graph` tasks hourly, the
Ah, indeed. I can confirm that this is misrendered when looking at
git-config(1), and with your patch it indeed renders correctly. Thanks
for this simple and obvious fix!
Thanks for the review! It's a minor change, but this is my first patch
to the git project, so I appreciate your time and expertise.

Cheers!
-- 
Brigham Campbell
https://brighamcampbell.com
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help