{"thread":{"id":"30497","subject":"[PATCH] Clean weird documentation for 'git var' and 'git","startedAt":"2012-05-10T16:45:12Z","lastAt":"2012-05-10T20:15:40Z","messageCount":9,"participants":["Philippe Vaucher","Junio C Hamano","René Scharfe","Philip Oakley"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"191319","messageId":"CAGK7Mr7QWrddaRLkr=1h=GYUNtNVOatQF1sj+p11mejzs65u8A@mail.gmail.com","threadId":"30497","inReplyTo":null,"subject":"[PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Philippe Vaucher","fromEmail":"philippe.vaucher@gmail.com","sentAt":"2012-05-10T16:45:12Z","receivedAt":"2012-05-10T16:45:12Z","isPatch":true,"sender":{"key":"philippe.vaucher@gmail.com","avatar":null},"body":"Here's a patch removing the weird bits. I spoke about in my previous message.\n\nPhilippe\n\n\nSigned-off-by: Philippe Vaucher \n---\n Documentation/git-commit-tree.txt | 9 ---------\n Documentation/git-var.txt | 9 ---------\n 2 files changed, 18 deletions(-)\n\ndiff --git a/Documentation/git-commit-tree.txt\nb/Documentation/git-commit-tree.txt\nindex cfb9906..eb8ee99 100644\n--- a/Documentation/git-commit-tree.txt\n+++ b/Documentation/git-commit-tree.txt\n@@ -88,15 +88,6 @@ for one to be entered and terminated with ^D.\n\n include::date-formats.txt[]\n\n-Diagnostics\n------------\n-You don't exist. Go away!::\n- The passwd(5) gecos field couldn't be read\n-Your parents must have hated you!::\n- The passwd(5) gecos field is longer than a giant static buffer.\n-Your sysadmin must hate you!::\n- The passwd(5) name field is longer than a giant static buffer.\n-\n Discussion\n ----------\n\ndiff --git a/Documentation/git-var.txt b/Documentation/git-var.txt\nindex 988a323..67edf58 100644\n--- a/Documentation/git-var.txt\n+++ b/Documentation/git-var.txt\n@@ -59,15 +59,6 @@ ifdef::git-default-pager[]\n The build you are using chose '{git-default-pager}' as the default.\n endif::git-default-pager[]\n\n-Diagnostics\n------------\n-You don't exist. Go away!::\n- The passwd(5) gecos field couldn't be read\n-Your parents must have hated you!::\n- The passwd(5) gecos field is longer than a giant static buffer.\n-Your sysadmin must hate you!::\n- The passwd(5) name field is longer than a giant static buffer.\n-\n SEE ALSO\n --------\n linkgit:git-commit-tree[1]\n-- \n1.7.9.5\n"},{"id":"191321","messageId":"CAGK7Mr7WQFmf1S5ed+1Cu9gRQ-ZgO-t+dj7a8PKRM=U2ZVERyQ@mail.gmail.com","threadId":"30497","inReplyTo":"CAGK7Mr7QWrddaRLkr=1h=GYUNtNVOatQF1sj+p11mejzs65u8A@mail.gmail.com","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Philippe Vaucher","fromEmail":"philippe.vaucher@gmail.com","sentAt":"2012-05-10T16:47:38Z","receivedAt":"2012-05-10T16:47:38Z","isPatch":true,"sender":{"key":"philippe.vaucher@gmail.com","avatar":null},"body":"I see I messed up the commit message which is too long. You can change\nit to something like \"Clean documentation (git-var/git-commit-tree)\"\nif you decide to import the patch.\n\nPhilippe\n"},{"id":"191324","messageId":"7vzk9gm0wa.fsf@alter.siamese.dyndns.org","threadId":"30497","inReplyTo":"CAGK7Mr7QWrddaRLkr=1h=GYUNtNVOatQF1sj+p11mejzs65u8A@mail.gmail.com","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-05-10T16:55:17Z","receivedAt":"2012-05-10T16:55:17Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Philippe Vaucher writes:\n\n> Here's a patch removing the weird bits. I spoke about in my previous message.\n\nWhat's weird about them? They are real messages issued exactly when they\nare described to be issued.\n"},{"id":"191326","messageId":"4FABF5A2.1050200@lsrfire.ath.cx","threadId":"30497","inReplyTo":"CAGK7Mr7QWrddaRLkr=1h=GYUNtNVOatQF1sj+p11mejzs65u8A@mail.gmail.com","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"René Scharfe","fromEmail":"rene.scharfe@lsrfire.ath.cx","sentAt":"2012-05-10T17:06:42Z","receivedAt":"2012-05-10T17:06:42Z","isPatch":true,"sender":{"key":"l.s.r@web.de","avatar":"https://avatars.githubusercontent.com/u/26122331?v=4"},"body":"Am 10.05.2012 18:45, schrieb Philippe Vaucher:\n> Here's a patch removing the weird bits. I spoke about in my previous message.\n\nIdeally, a commit message should be self-contained and explain the \nreasons for the introduced changes, or at least contain a link to a \nmailing list archive, so that readers who only have the git repository \nhave a chance to follow the arguments.\n\n>\n> Philippe\n>\n>\n> Signed-off-by: Philippe Vaucher\n\nThe author field of a commit plus the sign-off line are enough to \nidentify you, no extra line with your name required.\n\n> ---\n> Documentation/git-commit-tree.txt | 9 ---------\n> Documentation/git-var.txt | 9 ---------\n> 2 files changed, 18 deletions(-)\n>\n> diff --git a/Documentation/git-commit-tree.txt\n> b/Documentation/git-commit-tree.txt\n> index cfb9906..eb8ee99 100644\n> --- a/Documentation/git-commit-tree.txt\n> +++ b/Documentation/git-commit-tree.txt\n> @@ -88,15 +88,6 @@ for one to be entered and terminated with ^D.\n>\n> include::date-formats.txt[]\n>\n> -Diagnostics\n> ------------\n> -You don't exist. Go away!::\n> - The passwd(5) gecos field couldn't be read\n> -Your parents must have hated you!::\n> - The passwd(5) gecos field is longer than a giant static buffer.\n> -Your sysadmin must hate you!::\n> - The passwd(5) name field is longer than a giant static buffer.\n> -\n\nThese are actual error messages and their meanings, e.g. git prints \"You \ndon't exist. Go away!\" in case the gecos field of your account in \n/etc/passwd (or NIS, or LDAP) couldn't be read.\n\nRené\n"},{"id":"191332","messageId":"F89882854A7D45E2843F6F1F7CB21DB4@PhilipOakley","threadId":"30497","inReplyTo":"7vzk9gm0wa.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2012-05-10T18:03:19Z","receivedAt":"2012-05-10T18:03:19Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"From: \"Junio C Hamano\" Sent: Thursday, May 10, 2012 5:55 PM\n> Philippe Vaucher writes:\n>\n>> Here's a patch removing the weird bits. I spoke about in my previous message.\n>\n> What's weird about them? They are real messages issued exactly when they\n> are described to be issued.\n> --\n\nPhilippe,\n\nThe problem is surely that an explanatory line is needed to say that these are the diagnostic messages that occur in various cases. \nIts in 'ident.c'.\n\nPhilip \n"},{"id":"191335","messageId":"CAGK7Mr7rzuPVmGsnx+uhmVgBepAav734uh6hHeqn25BC0_+0Lw@mail.gmail.com","threadId":"30497","inReplyTo":"CAGK7Mr6AjSY-D9p1vzs=xCg-TMCPiBJDOSxMVYtykeCZCPW2FA@mail.gmail.com","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Philippe Vaucher","fromEmail":"philippe.vaucher@gmail.com","sentAt":"2012-05-10T18:26:21Z","receivedAt":"2012-05-10T18:26:21Z","isPatch":true,"sender":{"key":"philippe.vaucher@gmail.com","avatar":null},"body":">> What's weird about them?  They are real messages issued exactly when they are described to be issued.\n>\n> The problem is surely that an explanatory line is needed to say that these are the diagnostic messages that occur in various cases. Its in 'ident.c'.\n\nI guess I'm just unfamiliar with the \"Diagnostics\" section of a man\npage. When I fall on this there's nothing I learn... all the other\nsections are helpful and providing self explanatory informations.\n\nIn this case (diagnostic section), the first thing I see is \"You don't\nexist, Go away!\", and I'm like \"okay...\" then I see something about\nthe passwd file (what on earth has git-commit-tree in common with\npasswd?) then I see \"Your parents must have hated you!\" and there I'm\nlike \"okay, there's definitly something wrong with this man page\".\n\nI'm probably not the only one confused by this. I think a simple line\n\"This tool might report the following error messages\" would already be\na great step forward. The next step would be to improve those error\nmessages :)\n\nPhilippe\n"},{"id":"191336","messageId":"7vvck3najc.fsf@alter.siamese.dyndns.org","threadId":"30497","inReplyTo":"CAGK7Mr7rzuPVmGsnx+uhmVgBepAav734uh6hHeqn25BC0_+0Lw@mail.gmail.com","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-05-10T18:41:43Z","receivedAt":"2012-05-10T18:41:43Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Philippe Vaucher writes:\n\n>>> What's weird about them? They are real messages issued exactly when they are described to be issued.\n>>\n>> The problem is surely that an explanatory line is needed to say that these are the diagnostic messages that occur in various cases. Its in 'ident.c'.\n>\n> I guess I'm just unfamiliar with the \"Diagnostics\" section of a man\n> page.\n\nAhh, that makes your initial message understandable.\n\nIt indeed is not one of the very common and established ones, and it may\nhelp to give it a gentler introduction.\n\n Documentation/git-commit-tree.txt | 4 ++++\n Documentation/git-var.txt | 4 ++++\n 2 files changed, 8 insertions(+)\n\ndiff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt\nindex cfb9906..868ad09 100644\n--- a/Documentation/git-commit-tree.txt\n+++ b/Documentation/git-commit-tree.txt\n@@ -90,6 +90,10 @@ include::date-formats.txt[]\n \n Diagnostics\n -----------\n+\n+Some of the common error message the command may give upon errors are\n+listed here.\n+\n You don't exist. Go away!::\n The passwd(5) gecos field couldn't be read\n Your parents must have hated you!::\ndiff --git a/Documentation/git-var.txt b/Documentation/git-var.txt\nindex 988a323..394bfa7 100644\n--- a/Documentation/git-var.txt\n+++ b/Documentation/git-var.txt\n@@ -61,6 +61,10 @@ endif::git-default-pager[]\n \n Diagnostics\n -----------\n+\n+Some of the common error message the command may give upon errors are\n+listed here.\n+\n You don't exist. Go away!::\n The passwd(5) gecos field couldn't be read\n Your parents must have hated you!::\n"},{"id":"191348","messageId":"CAGK7Mr4GJw4zZ5Qwab+co07JG5kBn-EFsfmU+Yzpm6LoD8j-Rw@mail.gmail.com","threadId":"30497","inReplyTo":"7vvck3najc.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Philippe Vaucher","fromEmail":"philippe.vaucher@gmail.com","sentAt":"2012-05-10T20:14:39Z","receivedAt":"2012-05-10T20:14:39Z","isPatch":true,"sender":{"key":"philippe.vaucher@gmail.com","avatar":null},"body":">> I guess I'm just unfamiliar with the \"Diagnostics\" section of a man\n>> page.\n>\n> Ahh, that makes your initial message understandable.\n>\n> It indeed is not one of the very common and established ones, and it may\n> help to give it a gentler introduction.\n\nYes that's much better. Thanks!\n\nI think in the long term those error messages should be more\ndescriptive. For example \"Your parents must have hated you\" should be\n\"Your name is too long, maximum %d characters allowed\" or whatever.\n\nPhilippe\n"},{"id":"191349","messageId":"CAGK7Mr46-btS3gZvw4UUeiZEFn6cxH+BuYV02heWSbLbavpwvA@mail.gmail.com","threadId":"30497","inReplyTo":"CAGK7Mr4GJw4zZ5Qwab+co07JG5kBn-EFsfmU+Yzpm6LoD8j-Rw@mail.gmail.com","subject":"Re: [PATCH] Clean weird documentation for 'git var' and 'git","fromName":"Philippe Vaucher","fromEmail":"philippe.vaucher@gmail.com","sentAt":"2012-05-10T20:15:40Z","receivedAt":"2012-05-10T20:15:40Z","isPatch":true,"sender":{"key":"philippe.vaucher@gmail.com","avatar":null},"body":"Oh, I see there's already a patch for it :) Nice!\n\nPhilippe\n"}]}