{"thread":{"id":"11597","subject":"[PATCH] manpages: linking all mail-related commands","startedAt":"2008-01-11T23:48:06Z","lastAt":"2008-01-12T01:44:04Z","messageCount":3,"participants":["Humberto Diogenes","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"65096","messageId":"1200095286-2621-1-git-send-email-humberto@digi.com.br","threadId":"11597","inReplyTo":null,"subject":"[PATCH] manpages: linking all mail-related commands","fromName":"Humberto Diogenes","fromEmail":"humberto@digi.com.br","sentAt":"2008-01-11T23:48:06Z","receivedAt":"2008-01-11T23:48:06Z","isPatch":true,"sender":{"key":"humberto@digi.com.br","avatar":null},"body":"From: humberto \n\n---\n Documentation/git-am.txt | 6 ++++--\n Documentation/git-apply.txt | 4 ++++\n Documentation/git-format-patch.txt | 7 ++++---\n Documentation/git-imap-send.txt | 5 +++++\n Documentation/git-send-email.txt | 6 ++++++\n 5 files changed, 23 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-am.txt b/Documentation/git-am.txt\nindex e4a6b3a..fd00fc1 100644\n--- a/Documentation/git-am.txt\n+++ b/Documentation/git-am.txt\n@@ -144,8 +144,10 @@ names.\n \n SEE ALSO\n --------\n-gitlink:git-apply[1].\n-\n+gitlink:git-apply[1],\n+gitlink:git-format-patch[1],\n+gitlink:git-imap-send[1],\n+gitlink:git-send-email[1]\n \n Author\n ------\ndiff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt\nindex c1c54bf..53fa937 100644\n--- a/Documentation/git-apply.txt\n+++ b/Documentation/git-apply.txt\n@@ -189,6 +189,10 @@ If --index is not specified, then the submodule commits in the patch\n are ignored and only the absence of presence of the corresponding\n subdirectory is checked and (if possible) updated.\n \n+See Also\n+--------\n+gitlink:git-am[1]\n+\n Author\n ------\n Written by Linus Torvalds \ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex f0617ef..0221b6d 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -184,10 +184,11 @@ git-format-patch -3::\n \tExtract three topmost commits from the current branch\n \tand format them as e-mailable patches.\n \n-See Also\n+SEE ALSO\n --------\n-gitlink:git-am[1], gitlink:git-send-email[1]\n-\n+gitlink:git-am[1],\n+gitlink:git-imap-send[1],\n+gitlink:git-send-email[1]\n \n Author\n ------\ndiff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt\nindex eca9e9c..8397dcb 100644\n--- a/Documentation/git-imap-send.txt\n+++ b/Documentation/git-imap-send.txt\n@@ -48,6 +48,11 @@ BUGS\n ----\n Doesn't handle lines starting with \"From \" in the message body.\n \n+SEE ALSO\n+--------\n+gitlink:git-am[1],\n+gitlink:git-format-patch[1],\n+gitlink:git-send-email[1]\n \n Author\n ------\ndiff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\nindex 16bfd7b..9214596 100644\n--- a/Documentation/git-send-email.txt\n+++ b/Documentation/git-send-email.txt\n@@ -143,6 +143,12 @@ sendemail.chainreplyto::\n sendemail.smtpserver::\n \tDefault smtp server to use.\n \n+SEE ALSO\n+--------\n+gitlink:git-am[1],\n+gitlink:git-format-patch[1],\n+gitlink:git-imap-send[1]\n+\n Author\n ------\n Written by Ryan Anderson \n-- \n1.5.3.6\n"},{"id":"65099","messageId":"7vy7avzwx4.fsf@gitster.siamese.dyndns.org","threadId":"11597","inReplyTo":"1200095286-2621-1-git-send-email-humberto@digi.com.br","subject":"Re: [PATCH] manpages: linking all mail-related commands","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-01-12T00:53:43Z","receivedAt":"2008-01-12T00:53:43Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Humberto Diogenes writes:\n\n> diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt\n> index e4a6b3a..fd00fc1 100644\n> --- a/Documentation/git-am.txt\n> +++ b/Documentation/git-am.txt\n> @@ -144,8 +144,10 @@ names.\n> \n> SEE ALSO\n> --------\n> -gitlink:git-apply[1].\n> -\n> +gitlink:git-apply[1],\n> +gitlink:git-format-patch[1],\n> +gitlink:git-imap-send[1],\n> +gitlink:git-send-email[1]\n\nI do not see a point in this. \"am\" is a tool for people who\naccept and they do not care how the sender prepared\n(format-patch) nor sent (imap-send nor send-email).\n\nOn the other hand, as am uses mailinfo and mailsplit, it may be\nworth mentioning them (although I suspect not all the readers of\nmanual page of am are interested in such a low level details).\n\n> diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt\n> index c1c54bf..53fa937 100644\n> --- a/Documentation/git-apply.txt\n> +++ b/Documentation/git-apply.txt\n> @@ -189,6 +189,10 @@ If --index is not specified, then the submodule commits in the patch\n> are ignored and only the absence of presence of the corresponding\n> subdirectory is checked and (if possible) updated.\n> \n> +See Also\n> +--------\n> +gitlink:git-am[1]\n\nWhy? apply is not about email at all. am uses apply but not\nthe other way around.\n\nThis feels you are going a bit overboard, as if you are adding\n\"See Also: git[7]\" everywhere (even though it is not that bad).\n\n> -See Also\n> +SEE ALSO\n> --------\n\nIf you are standardizing between \"SEE ALSO\" and \"See Also\", I\nthink that is a worthy thing to do independent from the\nadditional links, but (1) please be consistent --- you tried to\nadd \"See Also\" yoruself above, (2) please have a separate patch\nthat does _ONLY_ the standardization to \"SEE ALSO\", and not\nlimited to commands that has (maybe remotely) something to do\nwith emailed patch workflow.\n\nRight now, I count 14 \"SEE ALSO\" and 17 \"See Also\". 127 spell\n\"Author\" and 5 spell \"AUTHOR\". Everybody says \"NAME\", \"SYNOPSIS\",\n\"DESCRIPTION\", and \"OPTIONS\".\n\nI think we should spell these in all uppercase.\n"},{"id":"65107","messageId":"B4D45D5C-618B-46E4-B66A-27914EF810A7@digi.com.br","threadId":"11597","inReplyTo":"7vy7avzwx4.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH] manpages: linking all mail-related commands","fromName":"Humberto Diogenes","fromEmail":"humberto@digi.com.br","sentAt":"2008-01-12T01:44:04Z","receivedAt":"2008-01-12T01:44:04Z","isPatch":true,"sender":{"key":"humberto@digi.com.br","avatar":null},"body":"\n Wow! I wasn't expecting that amount of reply for such a simple \npatch. :-) I just found it unnecessarily hard to discover all the \nemail-related commands in git (even though I already used some of \nthem). My point-of-view is that some additional links wouldn't hurt. \nMore answers below.\n\nOn 11/01/2008, at 21:53, Junio C Hamano wrote:\n\n> Humberto Diogenes writes:\n>\n>> diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt\n>> index e4a6b3a..fd00fc1 100644\n>> --- a/Documentation/git-am.txt\n>> +++ b/Documentation/git-am.txt\n>> @@ -144,8 +144,10 @@ names.\n>>\n>> SEE ALSO\n>> --------\n>> -gitlink:git-apply[1].\n>> -\n>> +gitlink:git-apply[1],\n>> +gitlink:git-format-patch[1],\n>> +gitlink:git-imap-send[1],\n>> +gitlink:git-send-email[1]\n>\n> I do not see a point in this. \"am\" is a tool for people who\n> accept and they do not care how the sender prepared\n> (format-patch) nor sent (imap-send nor send-email).\n\n Well, if I'm reading the docs about how a program works with some \ninput, I'll sure want to know which commands in the package generate \nthat kind of output. I think at least git-format-patch deserves a link \n(am: read, format-patch: write).\n And yes, I managed to find git-am and git-send-email but couldn't \nremember the name of git-format-patch.\n\n> On the other hand, as am uses mailinfo and mailsplit, it may be\n> worth mentioning them (although I suspect not all the readers of\n> manual page of am are interested in such a low level details).\n\n I think it wouldn't hurt.\n\n>> diff --git a/Documentation/git-apply.txt b/Documentation/git- \n>> apply.txt\n>> index c1c54bf..53fa937 100644\n>> --- a/Documentation/git-apply.txt\n>> +++ b/Documentation/git-apply.txt\n>> @@ -189,6 +189,10 @@ If --index is not specified, then the \n>> submodule commits in the patch\n>> are ignored and only the absence of presence of the corresponding\n>> subdirectory is checked and (if possible) updated.\n>>\n>> +See Also\n>> +--------\n>> +gitlink:git-am[1]\n>\n> Why? apply is not about email at all. am uses apply but not\n> the other way around.\n\n Imagine you don't know git, but know there's some command to apply \npatches from mailboxes. Which one would you try first: git-am or git- \napply? \"git-am\" just doesn't say anything (for beginners, at least).\n\n> This feels you are going a bit overboard, as if you are adding\n> \"See Also: git[7]\" everywhere (even though it is not that bad).\n\n Again: wouldn't hurt. :)\n\n>> -See Also\n>> +SEE ALSO\n>> --------\n>\n> If you are standardizing between \"SEE ALSO\" and \"See Also\", I\n> think that is a worthy thing to do independent from the\n> additional links, but (1) please be consistent --- you tried to\n> add \"See Also\" yoruself above, (2) please have a separate patch\n> that does _ONLY_ the standardization to \"SEE ALSO\", and not\n> limited to commands that has (maybe remotely) something to do\n> with emailed patch workflow.\n>\n> Right now, I count 14 \"SEE ALSO\" and 17 \"See Also\". 127 spell\n> \"Author\" and 5 spell \"AUTHOR\". Everybody says \"NAME\", \"SYNOPSIS\",\n> \"DESCRIPTION\", and \"OPTIONS\".\n>\n> I think we should spell these in all uppercase.\n\n Yes, I could see this one coming. Sorry.\n\n\n--\nHumberto Diógenes\nhttp://humberto.digi.com.br\n"}]}