Skip to content

Commit 3996943

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: patch-id: fix accidental literal blocks
All the final paragraphs on these three options are rendered as literal blocks. The intent was surely to keep each of them wed to their respective description list items. But the attempt at maintaining the indentation level of the block causes each them to be interpreted as a code block, since code blocks can be represented using indentation. We need to use list continuation (+) in order to keep them wed to their blocks. There is also an unordered list which sandwiches two paragraphs on an option. We don’t need to do anything about that since it attaches to the description list item without list continuation (i.e. it is already correct). But for consistency let’s use list continuation and an open block on it. Signed-off-by: Kristoffer Haugsbakk <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 16bd9f2 commit 3996943

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

Documentation/git-patch-id.adoc

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -33,36 +33,39 @@ OPTIONS
3333
--verbatim::
3434
Calculate the patch-id of the input as it is given, do not strip
3535
any whitespace.
36-
37-
This is the default if patchid.verbatim is true.
36+
+
37+
This is the default if patchid.verbatim is true.
3838

3939
--stable::
4040
Use a "stable" sum of hashes as the patch ID. With this option:
41-
- Reordering file diffs that make up a patch does not affect the ID.
42-
In particular, two patches produced by comparing the same two trees
43-
with two different settings for "-O<orderfile>" result in the same
44-
patch ID signature, thereby allowing the computed result to be used
45-
as a key to index some meta-information about the change between
46-
the two trees;
47-
48-
- Result is different from the value produced by git 1.9 and older
49-
or produced when an "unstable" hash (see --unstable below) is
50-
configured - even when used on a diff output taken without any use
51-
of "-O<orderfile>", thereby making existing databases storing such
52-
"unstable" or historical patch-ids unusable.
53-
54-
- All whitespace within the patch is ignored and does not affect the id.
55-
56-
This is the default if patchid.stable is set to true.
41+
+
42+
--
43+
- Reordering file diffs that make up a patch does not affect the ID.
44+
In particular, two patches produced by comparing the same two trees
45+
with two different settings for "-O<orderfile>" result in the same
46+
patch ID signature, thereby allowing the computed result to be used
47+
as a key to index some meta-information about the change between
48+
the two trees;
49+
50+
- Result is different from the value produced by git 1.9 and older
51+
or produced when an "unstable" hash (see --unstable below) is
52+
configured - even when used on a diff output taken without any use
53+
of "-O<orderfile>", thereby making existing databases storing such
54+
"unstable" or historical patch-ids unusable.
55+
56+
- All whitespace within the patch is ignored and does not affect the id.
57+
--
58+
+
59+
This is the default if patchid.stable is set to true.
5760
5861
--unstable::
5962
Use an "unstable" hash as the patch ID. With this option,
6063
the result produced is compatible with the patch-id value produced
6164
by git 1.9 and older and whitespace is ignored. Users with pre-existing
6265
databases storing patch-ids produced by git 1.9 and older (who do not deal
6366
with reordered patches) may want to use this option.
64-
65-
This is the default.
67+
+
68+
This is the default.
6669

6770
GIT
6871
---

0 commit comments

Comments
 (0)