From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: [PATCH] doc: patch-id: fix accidental literal blocks
Date: Sun, 28 Sep 2025 16:03:08 +0200 [thread overview]
Message-ID: <0520e8f9caf.1759067095.git.code@khaugsbakk.name> (raw)
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
The options here are apparently written with the assumption that you
can continue a block like e.g. a description list by maintaining the
same indentation level. This is not the the case; you need to use list
continuation (+) for the elements following the first paragraph if you
want to be guaranteed a predictable output
This is kind of subtle since only the last paragraph of each option gets
rendered in an unintended way, namely as literal blocks. This is easier
to see in the HTML output since the man page output just has a slightly
larger indentation on these paragraphs.
Let’s use list continuation throughout, collapse the indentation in
front of all paragraphs except the first one, and wrap the unordered
list in an open block (`--`).
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Documentation/git-patch-id.adoc | 43 ++++++++++++++++++---------------
1 file changed, 23 insertions(+), 20 deletions(-)
diff --git a/Documentation/git-patch-id.adoc b/Documentation/git-patch-id.adoc
index 1d15fa45d51..45da0f27acd 100644
--- a/Documentation/git-patch-id.adoc
+++ b/Documentation/git-patch-id.adoc
@@ -33,27 +33,30 @@ OPTIONS
--verbatim::
Calculate the patch-id of the input as it is given, do not strip
any whitespace.
-
- This is the default if patchid.verbatim is true.
++
+This is the default if patchid.verbatim is true.
--stable::
Use a "stable" sum of hashes as the patch ID. With this option:
- - Reordering file diffs that make up a patch does not affect the ID.
- In particular, two patches produced by comparing the same two trees
- with two different settings for "-O<orderfile>" result in the same
- patch ID signature, thereby allowing the computed result to be used
- as a key to index some meta-information about the change between
- the two trees;
-
- - Result is different from the value produced by git 1.9 and older
- or produced when an "unstable" hash (see --unstable below) is
- configured - even when used on a diff output taken without any use
- of "-O<orderfile>", thereby making existing databases storing such
- "unstable" or historical patch-ids unusable.
-
- - All whitespace within the patch is ignored and does not affect the id.
-
- This is the default if patchid.stable is set to true.
++
+--
+- Reordering file diffs that make up a patch does not affect the ID.
+ In particular, two patches produced by comparing the same two trees
+ with two different settings for "-O<orderfile>" result in the same
+ patch ID signature, thereby allowing the computed result to be used
+ as a key to index some meta-information about the change between
+ the two trees;
+
+- Result is different from the value produced by git 1.9 and older
+ or produced when an "unstable" hash (see --unstable below) is
+ configured - even when used on a diff output taken without any use
+ of "-O<orderfile>", thereby making existing databases storing such
+ "unstable" or historical patch-ids unusable.
+
+- All whitespace within the patch is ignored and does not affect the id.
+--
++
+This is the default if patchid.stable is set to true.
--unstable::
Use an "unstable" hash as the patch ID. With this option,
@@ -61,8 +64,8 @@ OPTIONS
by git 1.9 and older and whitespace is ignored. Users with pre-existing
databases storing patch-ids produced by git 1.9 and older (who do not deal
with reordered patches) may want to use this option.
-
- This is the default.
++
+This is the default.
GIT
---
base-commit: c44beea485f0f2feaf460e2ac87fdd5608d63cf0
--
2.51.0.327.gddebdc8c038
next reply other threads:[~2025-09-28 14:03 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-28 14:03 kristofferhaugsbakk [this message]
2025-09-28 15:45 ` [PATCH] doc: patch-id: fix accidental literal blocks Kristoffer Haugsbakk
2025-09-28 16:01 ` Junio C Hamano
2025-09-28 19:25 ` Kristoffer Haugsbakk
2025-09-28 19:37 ` Junio C Hamano
2025-09-29 20:47 ` [PATCH v2] " kristofferhaugsbakk
2025-09-29 22:18 ` Junio C Hamano
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=0520e8f9caf.1759067095.git.code@khaugsbakk.name \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
/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).