threads / patch / 63390

patch, 2 partsdoc: fix subheading and inline-verbatim

Subject: [PATCH 0/2] doc: fix subheading and inline-verbatim

## tl;dr

5 messages between May 3, 2025 and May 6, 2025. Diffs are folded; open one to read it.

replies: 4people: 3as markdown or json

kristofferhaugsbakk@fastmail.com· May 3, 2025, 19:13 UTC · lore
From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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
-- 
2.49.0.459.gf65182a99e5
kristofferhaugsbakk@fastmail.com· May 3, 2025, 19:13 UTC · re: kristofferhaugsbakk@fastmail.com · lore

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

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-reflog.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-reflog.adoc +1 −1
diff --git a/Documentation/git-reflog.adoc b/Documentation/git-reflog.adoc
index b55c0605697..412f06b8fec 100644
--- a/Documentation/git-reflog.adoc
+++ b/Documentation/git-reflog.adoc
@@ -138,7 +138,7 @@ Options for `delete`
 used with `expire`.
 
 Options for `drop`
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~
 
 --all::
 	Drop the reflogs of all references from all worktrees.

-- 
2.49.0.459.gf65182a99e5
kristofferhaugsbakk@fastmail.com· May 3, 2025, 19:13 UTC · re: kristofferhaugsbakk@fastmail.com · lore

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

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

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.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-branch.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-branch.adoc +1 −1
diff --git a/Documentation/git-branch.adoc b/Documentation/git-branch.adoc
index 50a1e13e1f2..c0afddc424d 100644
--- a/Documentation/git-branch.adoc
+++ b/Documentation/git-branch.adoc
@@ -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.

-- 
2.49.0.459.gf65182a99e5
Jean-Noël Avila· May 6, 2025, 13:01 UTC · re: kristofferhaugsbakk@fastmail.com · lore

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

Le 03/05/2025 à 21:13, kristofferhaugsbakk@fastmail.com a écrit :
Show 25 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
> 
> 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.
> 
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>  Documentation/git-branch.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/git-branch.adoc b/Documentation/git-branch.adoc
> index 50a1e13e1f2..c0afddc424d 100644
> --- a/Documentation/git-branch.adoc
> +++ b/Documentation/git-branch.adoc
> @@ -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!
Junio C Hamano· May 5, 2025, 17:47 UTC · re: kristofferhaugsbakk@fastmail.com · lore

Re: [PATCH 0/2] doc: fix subheading and inline-verbatim

kristofferhaugsbakk@fastmail.com writes:
Show 7 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> I found patch 1 by accident.  Then I looked over
> `Documentation/doc-diff` and made patch 2, after
> finding out about it.[1]
>
> 🔗 1: 
Both fixes look reasonable.
Thanks, will queue.

← back to recent threads