threads / patch / 64400

v2doc: git-checkout: fix placeholder markup

Subject: [PATCH v2 resend v2] doc: git-checkout: fix placeholder markup

## tl;dr

One message between Oct 28, 2025 and Oct 28, 2025. Diffs are folded; open one to read it.

replies: 0people: 1as markdown or json

kristofferhaugsbakk@fastmail.com· Oct 28, 2025, 18:19 UTC · lore
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
The placeholder markup is underscore (_), not backtick (`) as well.

The inline-verbatim markup (backticks) handle interior formatting. This means in this case that it applies HTML `<code>` to the underscores and `<em>` to the placeholder.

That is the effect, anyway; we can see from the rest of 042d6f34 (doc: git-checkout: clarify `-b` and `-B`, 2025-09-10) that this was probably an unintended mix-up.

Acked-by: Julia Evans <julia@jvns.ca>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    v2 resend:
    Resend as a separate thread this time. v2 is here:
    <v2-cb38c701537.1760716150.git.code@khaugsbakk.name>
    
    v2:
    Add Ack.  I also considered removing “probably” from “mix-up” but
    left it alone as a point-in-time note.  The msg + ack makes it clear.
    
    v1:
    Since this has landed in `master` now.
 Documentation/git-checkout.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Show changes to Documentation/git-checkout.adoc +2 −2
diff --git a/Documentation/git-checkout.adoc b/Documentation/git-checkout.adoc
index 431185ca0ba..6f281b298ef 100644
--- a/Documentation/git-checkout.adoc
+++ b/Documentation/git-checkout.adoc
@@ -61,7 +61,7 @@ uncommitted changes.
 `git checkout -B <branch> [<start-point>]`::
 
 	The same as `-b`, except that if the branch already exists it
-	resets `_<branch>_` to the start point instead of failing.
+	resets _<branch>_ to the start point instead of failing.
 
 `git checkout --detach [<branch>]`::
 `git checkout [--detach] <commit>`::
@@ -155,7 +155,7 @@ of it").
 
 `-B <new-branch>`::
 	The same as `-b`, except that if the branch already exists it
-	resets `_<branch>_` to the start point instead of failing.
+	resets _<branch>_ to the start point instead of failing.
 
 `-t`::
 `--track[=(direct|inherit)]`::

Range-diff against v1:
1:  54bc6875cc5 ! 1:  cb38c701537 doc: git-checkout: fix placeholder markup
    @@ Commit message
         git-checkout: clarify `-b` and `-B`, 2025-09-10) that this was probably
         an unintended mix-up.
     
    +    Acked-by: Julia Evans <julia@jvns.ca>
         Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
     
     
      ## Notes (series) ##
    +    v2 resend:
    +    Resend as a separate thread this time. v2 is here:
    +    <v2-cb38c701537.1760716150.git.code@khaugsbakk.name>
    +
    +    v2:
    +    Add Ack.  I also considered removing “probably” from “mix-up” but
    +    left it alone as a point-in-time note.  The msg + ack makes it clear.
    +
    +    v1:
         Since this has landed in `master` now.
     
      ## Documentation/git-checkout.adoc ##

base-commit: 83a9405e59e9cdfb587b19c50f0c040f346dd4ea
-- 
2.51.1.498.g8f0801f1c10

← back to recent threads