Skip to contentSkip to conversation

doc: fix subheading and inline-verbatim

PATCH In review [email protected] 3 participants 5 messages May 3, 2025 – May 6, 2025 Documentation

lore
Share & tools
lore
#0 lore raw

cover doc: fix subheading and inline-verbatim

From: Kristoffer Haugsbakk <[email protected]>

I found patch 1 by accident. Then I looked over
Documentation/doc-diff and made patch 2, after
finding out about it.[1]

🔗 1: https://lore.kernel.org/git/CAPig+cQoFC_2M-S0d7SLBPFvusXQC93pbk3QP2+qhsa7BJGnuQ@mail.gmail.com/

Kristoffer Haugsbakk (2):
doc: reflog: fix drop subheading
doc: branch: fix inline-verbatim

 Documentation/git-branch.adoc | 2 +-
 Documentation/git-reflog.adoc | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

base-commit: 6c0bd1fc70efaf053abe4e57c976afdc72d15377

Signature · 1 line
2.49.0.459.gf65182a99e5
#1 lore raw

PATCH 1/2 doc: reflog: fix `drop` subheading

From: Kristoffer Haugsbakk <[email protected]>

The tilde (~) count doesn’t match the length of the heading. In turn you get a bunch of <sub>~</sub> instead of the intended <h3> in the HTML output.

---
 Documentation/git-reflog.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-reflog.adoc +1 -1
index b55c0605697..412f06b8fec 100644
@@ -138,7 +138,7 @@ Options for `delete`
 used with `expire`.
 
 Options for `drop`
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~
 
 --all::
 	Drop the reflogs of all references from all worktrees.
Signature · 1 line
2.49.0.459.gf65182a99e5
#2 lore raw

PATCH 2/2 doc: branch: fix inline-verbatim

In reply to [email protected]

From: Kristoffer Haugsbakk <[email protected]>

7b399322a2e (doc: apply new format to git-branch man page, 2025-03-19) updated the formatting for this doc to, among other things, use backtick for some elements. In the process è was used by accident instead of backtick.

---
 Documentation/git-branch.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-branch.adoc +1 -1
index 50a1e13e1f2..c0afddc424d 100644
@@ -373,7 +373,7 @@ $ git branch -D test                                    <2>
 ------------
 +
 <1> Delete the remote-tracking branches "todo", "html" and "man". The next
-    `git fetch` or `git pullè will create them again unless you configure them not to.
+    `git fetch` or `git pull` will create them again unless you configure them not to.
     See linkgit:git-fetch[1].
 <2> Delete the "test" branch even if the "master" branch (or whichever branch
     is currently checked out) does not have all commits from the test branch.
Signature · 1 line
2.49.0.459.gf65182a99e5
#3 lore raw

Re: [PATCH 2/2] doc: branch: fix inline-verbatim

Le 03/05/2025 à 21:13, [email protected] a écrit :

Quoted 17 lines

From: Kristoffer Haugsbakk <[email protected]>

7b399322a2e (doc: apply new format to git-branch man page, 2025-03-19) updated the formatting for this doc to, among other things, use backtick for some elements. In the process è was used by accident instead of backtick.

---
 Documentation/git-branch.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-branch.adoc +0 -0
index 50a1e13e1f2..c0afddc424d 100644

Documentation/git-branch.adoc $ git branch -D test <2> · line 379

Quoted 8 lines
Documentation/git-branch.adoc +1 -1
@@ -373,7 +373,7 @@ $ git branch -D test                                    <2>
 ------------
 +
 <1> Delete the remote-tracking branches "todo", "html" and "man". The next
-    `git fetch` or `git pullè will create them again unless you configure them not to.
+    `git fetch` or `git pull` will create them again unless you configure them not to.
     See linkgit:git-fetch[1].
 <2> Delete the "test" branch even if the "master" branch (or whichever branch
     is currently checked out) does not have all commits from the test branch.

Thank you for spotting this one!