{"thread":{"id":"23894","subject":"[PATCH] Man page section reference should be in uppercase","startedAt":"2010-05-25T03:01:24Z","lastAt":"2010-05-27T19:50:17Z","messageCount":4,"participants":["Nazri Ramliy","Dévai Tamás","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"142228","messageId":"1274756484-27867-1-git-send-email-ayiehere@gmail.com","threadId":"23894","inReplyTo":null,"subject":"[PATCH] Man page section reference should be in uppercase","fromName":"Nazri Ramliy","fromEmail":"ayiehere@gmail.com","sentAt":"2010-05-25T03:01:24Z","receivedAt":"2010-05-25T03:01:24Z","isPatch":true,"sender":{"key":"ayiehere@gmail.com","avatar":"https://avatars.githubusercontent.com/u/164756?v=4"},"body":"From: nazri \n\nThe advice given by git push when doing a non-fast-forward push refers\nto the section 'Note about fast-forwards' in the git-push(1) man page.\n\nThe section name should really be all in uppercase, as in 'NOTE ABOUT\nFAST-FORWARDS' because that is how it is shown by git push --help.\n\nSigned-off-by: Nazri Ramliy \n---\n builtin/push.c | 4 ++--\n 1 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/builtin/push.c b/builtin/push.c\nindex f4358b9..0694200 100644\n--- a/builtin/push.c\n+++ b/builtin/push.c\n@@ -130,8 +130,8 @@ static int push_with_options(struct transport *transport, int flags)\n \n \tif (nonfastforward && advice_push_nonfastforward) {\n \t\tfprintf(stderr, \"To prevent you from losing history, non-fast-forward updates were rejected\\n\"\n-\t\t\t\t\"Merge the remote changes before pushing again. See the 'Note about\\n\"\n-\t\t\t\t\"fast-forwards' section of 'git push --help' for details.\\n\");\n+\t\t\t\t\"Merge the remote changes before pushing again. See the 'NOTE ABOUT\\n\"\n+\t\t\t\t\"FAST-FORWARDS' section of 'git push --help' for details.\\n\");\n \t}\n \n \treturn 1;\n-- \n1.7.1.rc1.21.gf3bd6\n"},{"id":"142291","messageId":"1274813122.1178.8.camel@localhost.localdomain","threadId":"23894","inReplyTo":"1274756484-27867-1-git-send-email-ayiehere@gmail.com","subject":"Re: [PATCH] Man page section reference should be in uppercase","fromName":"Dévai Tamás","fromEmail":"devait@vnet.hu","sentAt":"2010-05-25T18:45:22Z","receivedAt":"2010-05-25T18:45:22Z","isPatch":true,"sender":{"key":"devait@vnet.hu","avatar":null},"body":"2010. 05. 25, kedd keltezéssel 11.01-kor Nazri Ramliy ezt írta:\n> From: nazri \n> \n> The advice given by git push when doing a non-fast-forward push refers\n> to the section 'Note about fast-forwards' in the git-push(1) man page.\n> \n> The section name should really be all in uppercase, as in 'NOTE ABOUT\n> FAST-FORWARDS' because that is how it is shown by git push --help.\n> \n\nI don't really agree with this, but it might be only my personal\npreference. Reasons:\n\nThe section title in the man page is \"typeset\" in a \"different font\" to\nbe easily distinguishable from the surrounding text -- therefore it's\nall capital. On the other hand, changing the reference in the advice\ngiven by git-push to be all uppercase will give a needless emphasis on\nthe referred section title. This is wrong IMHO, because the main point\nof the advice is not this reference, but the earlier sentences (i.e. the\npush was rejected).\n\n> Signed-off-by: Nazri Ramliy \n> ---\n> builtin/push.c | 4 ++--\n> 1 files changed, 2 insertions(+), 2 deletions(-)\n> \n> diff --git a/builtin/push.c b/builtin/push.c\n> index f4358b9..0694200 100644\n> --- a/builtin/push.c\n> +++ b/builtin/push.c\n> @@ -130,8 +130,8 @@ static int push_with_options(struct transport *transport, int flags)\n> \n> \tif (nonfastforward && advice_push_nonfastforward) {\n> \t\tfprintf(stderr, \"To prevent you from losing history, non-fast-forward updates were rejected\\n\"\n> -\t\t\t\t\"Merge the remote changes before pushing again. See the 'Note about\\n\"\n> -\t\t\t\t\"fast-forwards' section of 'git push --help' for details.\\n\");\n> +\t\t\t\t\"Merge the remote changes before pushing again. See the 'NOTE ABOUT\\n\"\n> +\t\t\t\t\"FAST-FORWARDS' section of 'git push --help' for details.\\n\");\n> \t}\n> \n> \treturn 1;\n"},{"id":"142353","messageId":"AANLkTingglKSMHOcHXTg3hGF_czcFsnWLTd3GuSp-Mm6@mail.gmail.com","threadId":"23894","inReplyTo":"AANLkTilKSLCGMgHwB4TdojtemnxYLrGsAJGHQcLJNVwL@mail.gmail.com","subject":"Fwd: [PATCH] Man page section reference should be in uppercase","fromName":"Nazri Ramliy","fromEmail":"ayiehere@gmail.com","sentAt":"2010-05-26T08:33:26Z","receivedAt":"2010-05-26T08:33:26Z","isPatch":true,"sender":{"key":"ayiehere@gmail.com","avatar":"https://avatars.githubusercontent.com/u/164756?v=4"},"body":"I forgot to reply to the list as well when sending the (now forwarded)\nmessage below.\n\nApparently only Dévai Tamás received it, and replied to me:\n\nDévai Tamás wrote to me:\n> I didn't know that. Thanks for pointing out.\n\nApology for the top-posting-ish nature of this email.\n\nI guess when forwarding an email verbatim, it's ok to top post it with a\nheader of some sort?\n\nnazri.\n\n---------- Forwarded message ----------\nFrom: Nazri Ramliy \nDate: Wed, May 26, 2010 at 9:52 AM\nSubject: Re: [PATCH] Man page section reference should be in uppercase\nTo: Dévai Tamás \n\n\nOn Wed, May 26, 2010 at 2:45 AM, Dévai Tamás wrote:\n> I don't really agree with this, but it might be only my personal\n> preference. Reasons:\n>\n> The section title in the man page is \"typeset\" in a \"different font\" to\n> be easily distinguishable from the surrounding text -- therefore it's\n> all capital. On the other hand, changing the reference in the advice\n> given by git-push to be all uppercase will give a needless emphasis on\n> the referred section title. This is wrong IMHO, because the main point\n> of the advice is not this reference, but the earlier sentences (i.e. the\n> push was rejected).\n\nKeeping the reference to be in lowercase goes against what is\ncurrently practiced the man pages of git commands.  Have a look at the\noutput of\n\n       $ git grep '\"[A-z ]\\+\" section'\n\nSee how all of them use all-caps when referring to man page sections.\n\nIf the user is already familiar with the non-fast-forward push issue,\nthey would know how to proceed and ignored the 'needless' emphasis.\n\nBut for a user who is clueless about the non-fast-forward push issue the\nemphasis is good and even more important than that is that it is\nspelled out in the same exact form as how it will be rendered when the\nuser run 'git push --help', IMHO.\n\nnazri.\n"},{"id":"142464","messageId":"7v4ohtp1ja.fsf@alter.siamese.dyndns.org","threadId":"23894","inReplyTo":"AANLkTingglKSMHOcHXTg3hGF_czcFsnWLTd3GuSp-Mm6@mail.gmail.com","subject":"Re: Fwd: [PATCH] Man page section reference should be in uppercase","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2010-05-27T19:50:17Z","receivedAt":"2010-05-27T19:50:17Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Nazri Ramliy writes:\n\n>        $ git grep '\"[A-z ]\\+\" section'\n>\n> See how all of them use all-caps when referring to man page sections.\n\n\"TEMPLATE DIRECTORY\" and \"SPECIFYING REVISIONS\" are shown quite often, but\nthere are some others that deviate from your \"all caps\" norm. For\nexample, 'see the \"Configuration Mechanism\" section' appears in git.txt\nand it matches how the section header that is referred to is spelled.\n\nAlso the section headers referred to in caps in the current documentation\nset are indeed spelled in caps (grep for \"TEMPLATE DIRECTORY\" in\nDocumentation/git-init.txt for example).\n\nHaving said that, I wouldn't mind if the theme of your improvement were to\nspell manual section *headers* in caps, instead of leaving the actual\nsection names still spelled as \"Note about fast-forwards\" and upcasing\nonly the reference(s) to it, which can make things inconsistent depending\non how the documentation is typeset (e.g. I read the documentation source\nas text files). Obviously the resulting patchset may also have to upcase\ne.g. \"combined diff format\" section header to bring consistency into the\nwhole documentation set, not just the \"Note about fast-forwards\" section.\n"}]}