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

[PATCH 2/2] Documentation: "git pull" does not have the "-m" option

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 14, 2014, 19:57 UTC
Message-ID
<xmqq7ga249b1.fsf@gitster.dls.corp.google.com>
In-Reply-To
<7v61pm1hfe.fsf@alter.siamese.dyndns.org>

Even though "--[no-]edit" can be used with "git pull", the explanation of the interaction between this option and the "-m" option does not make sense within the context of "git pull". Use the conditional inclusion mechanism to remove this part from "git pull" documentation, while keeping it for "git merge".

Reported-by: Ivan Zakharyaschev
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 * Merge the result of applying 1/2 on top of 409b8d8 to 66fa1b2,
   and then apply this.
 Documentation/merge-options.txt | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index f192cd2..d462bcc 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -14,9 +14,12 @@ inspect and further tweak the merge result before committing.
 	further edit the auto-generated merge message, so that the user
 	can explain and justify the merge. The `--no-edit` option can be
 	used to accept the auto-generated message (this is generally
-	discouraged). The `--edit` (or `-e`) option is still useful if you are
-	giving a draft message with the `-m` option from the command line
-	and want to edit it in the editor.
+	discouraged).
+ifndef::git-pull[]
+The `--edit` (or `-e`) option is still useful if you are
+giving a draft message with the `-m` option from the command line
+and want to edit it in the editor.
+endif::git-pull[]
 +
 Older scripts may depend on the historical behaviour of not allowing the
 user to edit the merge log message. They will see an editor opened when
-- 
1.8.5.3-493-gb139ac2
Previous: Junio C Hamano
Message 6 of 6 in “BUG: manpage for git-pull mentions a non-valid option -m in a comment”
  1. Ivan ZakharyaschevJan 14, 2014
  2. Re* manpage for git-pull mentions a non-valid option -m in a commentJunio C Hamano, Jan 14, 2014
  3. Torsten BögershausenJan 14, 2014
  4. Junio C HamanoJan 14, 2014
  5. 1/2 Documentation: exclude irrelevant options from "git pull"Junio C Hamano, Jan 14, 2014
  6. 2/2 Documentation: "git pull" does not have the "-m" optionJunio C Hamano, Jan 14, 2014

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.