git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 1/2] diff, log doc: say "patch text" instead of "patches"

From
Johannes Sixt <j6t@kdbg.org>
Date
Sep 15, 2019, 16:55 UTC
Message-ID
<fac55175-dc1e-addf-194b-97aaf6a33e3b@kdbg.org>

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.

Mention porcelain commands before plumbing commands because I guess that the paragraph is read more frequently in their context.

Signed-off-by: Johannes Sixt <j6t@kdbg.org>
---
 I do not have the toolchain to check that a correct result is produced.
 Documentation/diff-generate-patch.txt | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
index f10ca410ad..c6bbb2ac22 100644
--- a/Documentation/diff-generate-patch.txt
+++ b/Documentation/diff-generate-patch.txt
@@ -1,11 +1,12 @@
-Generating patches with -p
---------------------------
-
-When "git-diff-index", "git-diff-tree", or "git-diff-files" are run
-with a `-p` option, "git diff" without the `--raw` option, or
-"git log" with the "-p" option, they
-do not produce the output described above; instead they produce a
-patch file.  You can customize the creation of such patches via the
+Generating patch text with -p
+-----------------------------
+
+Running
+linkgit:git-diff[1] without the `--raw` option,
+or linkgit:git-log[1], linkgit:git-diff-index[1], linkgit:git-diff-tree[1],
+or linkgit:git-diff-files[1] with the `-p` option
+produces patch text instead of the usual output.
+You can customize the creation of patch text via the
 `GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.
 
 What the -p option produces is slightly different from the traditional
-- 
2.23.0.93.g91d3f15def
Next: Johannes Sixt
Message 1 of 6 in “diff, log doc: say "patch text" instead of "patches"”
  1. 1/2 diff, log doc: say "patch text" instead of "patches"Johannes Sixt, Sep 15, 2019
  2. 2/2 diff, log doc: small grammer, format, and language fixesJohannes Sixt, Sep 15, 2019
  3. Martin ÅgrenSep 16, 2019
  4. Junio C HamanoSep 16, 2019
  5. 1/2 diff, log doc: say "patch text" instead of "patches"Johannes Sixt, Sep 16, 2019
  6. Martin ÅgrenSep 17, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.