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

[PATCH] git-format-patch.txt: don't show -s as shorthand for multiple options

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Mar 27, 2016, 21:26 UTC
Message-ID
<1459113967-13864-1-git-send-email-sunshine@sunshineco.com>

git-format-patch recognizes -s as shorthand only for --signoff, however, its documentation shows -s as shorthand for both --signoff and --no-patch. Resolve this confusion by suppressing the bogus -s shorthand for --no-patch.

While here, also avoid showing the --no-patch option in git-format-patch documentation since it doesn't make sense to ask to suppress the patch while at the same time explicitly asking to format the patch (which, after all, is the purpose of git-format-patch).

Reported-by: Kevin Brodsky <corax26@gmail.com>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---

I haven't quite managed to trace the code yet, but git-format-patch oddly does recognize --no-patch, and it appears to act as an alias of --no-stat. At any rate, --no-patch seems rather senseless with git-format-patch, hence this patch suppresses it in documentation altogether.

Documentation/diff-options.txt | 2 ++
 1 file changed, 2 insertions(+)
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 306b7e3..6eb591f 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -28,10 +28,12 @@ ifdef::git-diff[]
 endif::git-diff[]
 endif::git-format-patch[]
 
+ifndef::git-format-patch[]
 -s::
 --no-patch::
 	Suppress diff output. Useful for commands like `git show` that
 	show the patch by default, or to cancel the effect of `--patch`.
+endif::git-format-patch[]
 
 -U<n>::
 --unified=<n>::
-- 
2.8.0.rc4.285.gc3ac548
Next: Eric Sunshine
Message 1 of 8 in “git-format-patch.txt: don't show -s as shorthand for multiple options”
  1. git-format-patch.txt: don't show -s as shorthand for multiple optionsEric Sunshine, Mar 27, 2016
  2. Eric SunshineApr 4, 2016
  3. Junio C HamanoApr 4, 2016
  4. Eric SunshineApr 4, 2016
  5. Junio C HamanoApr 4, 2016
  6. Eric SunshineApr 4, 2016
  7. Eric SunshineApr 4, 2016
  8. Jacob KellerApr 8, 2016

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.