Skip to content

Commit 6fae6bd

Browse files
j6tgitster
authored andcommitted
diff, log doc: say "patch text" instead of "patches"
diff, log doc: say "patch text" instead of "patches" A poster on Stackoverflow was confused that the documentation of git-log promised to generate "patches" or "patch files" with -p, but there were none to be found. Rewrite the corresponding paragraph to talk about "patch text" to avoid the confusion. Shorten the language to say "X does Y" in place of "X does not Z, but Y". Cross-reference the referred-to commands like the rest of the file does. Enumerate git-show because it includes the description as well. Mention porcelain commands before plumbing commands because I guess that the paragraph is read more frequently in their context. Signed-off-by: Johannes Sixt <[email protected]> Acked-by: Martin Ågren <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5fa0f52 commit 6fae6bd

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

Documentation/diff-generate-patch.txt

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
Generating patches with -p
2-
--------------------------
3-
4-
When "git-diff-index", "git-diff-tree", or "git-diff-files" are run
5-
with a `-p` option, "git diff" without the `--raw` option, or
6-
"git log" with the "-p" option, they
7-
do not produce the output described above; instead they produce a
8-
patch file. You can customize the creation of such patches via the
1+
Generating patch text with -p
2+
-----------------------------
3+
4+
Running
5+
linkgit:git-diff[1],
6+
linkgit:git-log[1],
7+
linkgit:git-show[1],
8+
linkgit:git-diff-index[1],
9+
linkgit:git-diff-tree[1], or
10+
linkgit:git-diff-files[1]
11+
with the `-p` option produces patch text.
12+
You can customize the creation of patch text via the
913
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.
1014

1115
What the -p option produces is slightly different from the traditional

0 commit comments

Comments
 (0)