{"thread":{"id":"35650","subject":"BUG: manpage for git-pull mentions a non-valid option -m in a comment","startedAt":"2014-01-14T02:09:47Z","lastAt":"2014-01-14T19:57:03Z","messageCount":6,"participants":["Ivan Zakharyaschev","Junio C Hamano","Torsten Bögershausen"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"233077","messageId":"loom.20140114T025825-557@post.gmane.org","threadId":"35650","inReplyTo":null,"subject":"BUG: manpage for git-pull mentions a non-valid option -m in a comment","fromName":"Ivan Zakharyaschev","fromEmail":"imz@altlinux.org","sentAt":"2014-01-14T02:09:47Z","receivedAt":"2014-01-14T02:09:47Z","isPatch":false,"sender":{"key":"imz@altlinux.org","avatar":null},"body":"Hello!\n\ngit-1.8.4.4\n\nThe manpage for git-pull mentions -m in a comment:\n\n--edit, -e, --no-edit\nInvoke an editor before committing successful mechanical merge to further edit\nthe auto-generated merge message, so that the user can explain and justify the\nmerge. The --no-edit option can be used to accept the auto-generated message\n(this is generally discouraged). The --edit (or -e) option is still useful if\nyou are giving a draft message with the -m option from the command line and\nwant to edit it in the editor.\n\nbut it is not accepted actually:\n\ngit pull --no-edit -m 'Restoring config etc from server' \\\n origin server/GITCONFIG/master\nfatal: No such remote or remote group: Restoring config etc from server\n\nI'm not sure whether it is a bug of the implementation or of the documentation.\n\n(I've also written down this issue at\nhttps://bugzilla.altlinux.org/show_bug.cgi?id=29718 .)\n\nBest regards,\nIvan\n"},{"id":"233095","messageId":"xmqqvbxm4dyq.fsf@gitster.dls.corp.google.com","threadId":"35650","inReplyTo":"loom.20140114T025825-557@post.gmane.org","subject":"Re* manpage for git-pull mentions a non-valid option -m in a comment","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2014-01-14T18:26:21Z","receivedAt":"2014-01-14T18:26:21Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ivan Zakharyaschev writes:\n\n> Hello!\n>\n> git-1.8.4.4\n>\n> The manpage for git-pull mentions -m in a comment:\n>\n> --edit, -e, --no-edit\n> Invoke an editor before committing successful mechanical merge to further edit\n> the auto-generated merge message, so that the user can explain and justify the\n> merge. The --no-edit option can be used to accept the auto-generated message\n> (this is generally discouraged). The --edit (or -e) option is still useful if\n> you are giving a draft message with the -m option from the command line and\n> want to edit it in the editor.\n>\n> but it is not accepted actually:\n\nI do not think \"git pull\" ever had the \"-m \" option; what\nyou are seeing probably is a fallout from attempting to share the\ndocumentation pieces between \"git pull\" and \"git merge\" too\nagressively without proofreading.\n\nIt seems that there are two issues; here is an untested attempt to\nfix.\n\n-- >8 --\nSubject: Documentaiotn: exclude irrelevant options from \"git pull\"\n\n10eb64f5 (git pull manpage: don't include -n from fetch-options.txt,\n2008-01-25) introduced a way to exclude some parts of included\nsource when building git-pull documentation, and later 409b8d82\n(Documentation/git-pull: put verbosity options before merge/fetch\nones, 2010-02-24) attempted to use the mechanism to exclude some\nparts of merge-options.txt when used from git-pull.txt.\n\nHowever, the latter did not have an intended effect, because the\nmacro \"git-pull\" used to decide if the source is included in\ngit-pull documentation were defined a bit too late.\n\nDefine the macro before it is used to fix this.\n\nEven though \"--[no-]edit\" can be used with \"git pull\", the\nexplanation of the interaction between this option and the \"-m\"\noption does not make sense within the context of \"git pull\". Use\nthe same conditional inclusion mechanism to remove this part from\n\"git pull\" documentation, while keeping it for \"git merge\".\n\nReported-by: Ivan Zakharyaschev\nSigned-off-by: Junio C Hamano \n---\n\n Documentation/git-pull.txt | 4 ++--\n Documentation/merge-options.txt | 9 ++++++---\n 2 files changed, 8 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt\nindex 6083aab..200eb22 100644\n--- a/Documentation/git-pull.txt\n+++ b/Documentation/git-pull.txt\n@@ -99,10 +99,10 @@ must be given before the options meant for 'git fetch'.\n Options related to merging\n ~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n-include::merge-options.txt[]\n-\n :git-pull: 1\n \n+include::merge-options.txt[]\n+\n -r::\n --rebase[=false|true|preserve]::\n \tWhen true, rebase the current branch on top of the upstream\ndiff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt\nindex afba8d4..e134315 100644\n--- a/Documentation/merge-options.txt\n+++ b/Documentation/merge-options.txt\n@@ -14,9 +14,12 @@ inspect and further tweak the merge result before committing.\n \tfurther edit the auto-generated merge message, so that the user\n \tcan explain and justify the merge. The `--no-edit` option can be\n \tused to accept the auto-generated message (this is generally\n-\tdiscouraged). The `--edit` (or `-e`) option is still useful if you are\n-\tgiving a draft message with the `-m` option from the command line\n-\tand want to edit it in the editor.\n+\tdiscouraged).\n+ifndef::git-pull[]\n+The `--edit` (or `-e`) option is still useful if you are\n+giving a draft message with the `-m` option from the command line\n+and want to edit it in the editor.\n+endif::git-pull[]\n +\n Older scripts may depend on the historical behaviour of not allowing the\n user to edit the merge log message. They will see an editor opened when\n"},{"id":"233097","messageId":"52D5874D.7070102@web.de","threadId":"35650","inReplyTo":"xmqqvbxm4dyq.fsf@gitster.dls.corp.google.com","subject":"Re: Re* manpage for git-pull mentions a non-valid option -m in a comment","fromName":"Torsten Bögershausen","fromEmail":"tboegi@web.de","sentAt":"2014-01-14T18:51:57Z","receivedAt":"2014-01-14T18:51:57Z","isPatch":false,"sender":{"key":"tboegi@web.de","avatar":"https://avatars.githubusercontent.com/u/7138363?v=4"},"body":"On 2014-01-14 19.26, Junio C Hamano wrote:\n> Ivan Zakharyaschev writes:\n> \n>> Hello!\n>>\n>> git-1.8.4.4\n>>\n>> The manpage for git-pull mentions -m in a comment:\n>>\n>> --edit, -e, --no-edit\n>> Invoke an editor before committing successful mechanical merge to further edit\n>> the auto-generated merge message, so that the user can explain and justify the\n>> merge. The --no-edit option can be used to accept the auto-generated message\n>> (this is generally discouraged). The --edit (or -e) option is still useful if\n>> you are giving a draft message with the -m option from the command line and\n>> want to edit it in the editor.\n>>\n>> but it is not accepted actually:\n> \n> I do not think \"git pull\" ever had the \"-m \" option; what\n> you are seeing probably is a fallout from attempting to share the\n> documentation pieces between \"git pull\" and \"git merge\" too\n> agressively without proofreading.\n> \n> It seems that there are two issues; here is an untested attempt to\n> fix.\n> \n> -- >8 --\n> Subject: Documentaiotn: exclude irrelevant options from \"git pull\"\n ^^^^^^^^^^^^^^\n(Small nit ??)\n"},{"id":"233100","messageId":"7v61pm1hfe.fsf@alter.siamese.dyndns.org","threadId":"35650","inReplyTo":"52D5874D.7070102@web.de","subject":"Re: Re* manpage for git-pull mentions a non-valid option -m in a comment","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2014-01-14T19:39:49Z","receivedAt":"2014-01-14T19:39:49Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Torsten Bögershausen writes:\n\n>> Subject: Documentaiotn: exclude irrelevant options from \"git pull\"\n> ^^^^^^^^^^^^^^\n> (Small nit ??)\n\n;-).\n\nThey are now a small two patch series, with typofix for the above.\n"},{"id":"233102","messageId":"xmqqd2ju49b3.fsf@gitster.dls.corp.google.com","threadId":"35650","inReplyTo":"7v61pm1hfe.fsf@alter.siamese.dyndns.org","subject":"[PATCH 1/2] Documentation: exclude irrelevant options from \"git pull\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2014-01-14T19:54:45Z","receivedAt":"2014-01-14T19:54:45Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"10eb64f5 (git pull manpage: don't include -n from fetch-options.txt,\n2008-01-25) introduced a way to exclude some parts of included\nsource when building git-pull documentation, and later 409b8d82\n(Documentation/git-pull: put verbosity options before merge/fetch\nones, 2010-02-24) attempted to use the mechanism to exclude some\nparts of merge-options.txt when used from git-pull.txt.\n\nHowever, the latter did not have an intended effect, because the\nmacro \"git-pull\" used to decide if the source is included in\ngit-pull documentation were defined a bit too late.\n\nDefine the macro before it is used to fix this.\n\nSigned-off-by: Junio C Hamano \n---\n\n * To be applied on top of 409b8d82 (Documentation/git-pull: put\n verbosity options before merge/fetch ones, 2010-02-24)\n\n Documentation/git-pull.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt\nindex d47f9dd..0e7a1fe 100644\n--- a/Documentation/git-pull.txt\n+++ b/Documentation/git-pull.txt\n@@ -42,10 +42,10 @@ OPTIONS\n Options related to merging\n ~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n-include::merge-options.txt[]\n-\n :git-pull: 1\n \n+include::merge-options.txt[]\n+\n --rebase::\n \tInstead of a merge, perform a rebase after fetching. If\n \tthere is a remote ref for the upstream branch, and this branch\n-- \n1.8.5.3-493-gb139ac2\n"},{"id":"233103","messageId":"xmqq7ga249b1.fsf@gitster.dls.corp.google.com","threadId":"35650","inReplyTo":"7v61pm1hfe.fsf@alter.siamese.dyndns.org","subject":"[PATCH 2/2] Documentation: \"git pull\" does not have the \"-m\" option","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2014-01-14T19:57:03Z","receivedAt":"2014-01-14T19:57:03Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Even though \"--[no-]edit\" can be used with \"git pull\", the\nexplanation of the interaction between this option and the \"-m\"\noption does not make sense within the context of \"git pull\". Use\nthe conditional inclusion mechanism to remove this part from \"git\npull\" documentation, while keeping it for \"git merge\".\n\nReported-by: Ivan Zakharyaschev\nSigned-off-by: Junio C Hamano \n---\n * Merge the result of applying 1/2 on top of 409b8d8 to 66fa1b2,\n and then apply this.\n\n Documentation/merge-options.txt | 9 ++++++---\n 1 file changed, 6 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt\nindex f192cd2..d462bcc 100644\n--- a/Documentation/merge-options.txt\n+++ b/Documentation/merge-options.txt\n@@ -14,9 +14,12 @@ inspect and further tweak the merge result before committing.\n \tfurther edit the auto-generated merge message, so that the user\n \tcan explain and justify the merge. The `--no-edit` option can be\n \tused to accept the auto-generated message (this is generally\n-\tdiscouraged). The `--edit` (or `-e`) option is still useful if you are\n-\tgiving a draft message with the `-m` option from the command line\n-\tand want to edit it in the editor.\n+\tdiscouraged).\n+ifndef::git-pull[]\n+The `--edit` (or `-e`) option is still useful if you are\n+giving a draft message with the `-m` option from the command line\n+and want to edit it in the editor.\n+endif::git-pull[]\n +\n Older scripts may depend on the historical behaviour of not allowing the\n user to edit the merge log message. They will see an editor opened when\n-- \n1.8.5.3-493-gb139ac2\n"}]}