{"thread":{"id":"31280","subject":"[PATCH 0/2] Fix two minor problems in the docs for git-config","startedAt":"2012-08-18T17:32:08Z","lastAt":"2012-08-19T09:33:21Z","messageCount":7,"participants":["mhagger@alum.mit.edu","Junio C Hamano","Michael Haggerty"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"197246","messageId":"1345311130-20426-1-git-send-email-mhagger@alum.mit.edu","threadId":"31280","inReplyTo":null,"subject":"[PATCH 0/2] Fix two minor problems in the docs for git-config","fromName":"","fromEmail":"mhagger@alum.mit.edu","sentAt":"2012-08-18T17:32:08Z","receivedAt":"2012-08-18T17:32:08Z","isPatch":true,"sender":{"key":"mhagger@alum.mit.edu","avatar":"https://avatars.githubusercontent.com/u/119718?v=4"},"body":"From: Michael Haggerty \n\nThis is just something I stumbled across.\n\nMichael Haggerty (2):\n git-config.txt: properly escape quotation marks in example\n git-config.txt: fix example\n\n Documentation/git-config.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\n-- \n1.7.11.3\n"},{"id":"197247","messageId":"1345311130-20426-2-git-send-email-mhagger@alum.mit.edu","threadId":"31280","inReplyTo":"1345311130-20426-1-git-send-email-mhagger@alum.mit.edu","subject":"[PATCH 1/2] git-config.txt: properly escape quotation marks in example","fromName":"","fromEmail":"mhagger@alum.mit.edu","sentAt":"2012-08-18T17:32:09Z","receivedAt":"2012-08-18T17:32:09Z","isPatch":true,"sender":{"key":"mhagger@alum.mit.edu","avatar":"https://avatars.githubusercontent.com/u/119718?v=4"},"body":"From: Michael Haggerty \n\nIn the example line as written,\n\n gitproxy=\"proxy-command\" for kernel.org\n\nthe quotation marks are eaten by the config-file parser. From the\nhistory, it looks like this example wanted to have quotation marks in\nthe actual configured value. So quote them as required nowadays.\n\nSigned-off-by: Michael Haggerty \n---\n\nThe bigger question is whether this example is improved by including\nquotation marks, or whether they are just a distraction from the main\npoint. I abstain.\n\n Documentation/git-config.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 2d6ef32..46775fe 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -267,7 +267,7 @@ Given a .git/config like this:\n \n \t; Proxy settings\n \t[core]\n-\t\tgitproxy=\"proxy-command\" for kernel.org\n+\t\tgitproxy=\\\"proxy-command\\\" for kernel.org\n \t\tgitproxy=default-proxy ; for all the rest\n \n you can set the filemode to true with\n-- \n1.7.11.3\n"},{"id":"197248","messageId":"1345311130-20426-3-git-send-email-mhagger@alum.mit.edu","threadId":"31280","inReplyTo":"1345311130-20426-1-git-send-email-mhagger@alum.mit.edu","subject":"[PATCH 2/2] git-config.txt: fix example","fromName":"","fromEmail":"mhagger@alum.mit.edu","sentAt":"2012-08-18T17:32:10Z","receivedAt":"2012-08-18T17:32:10Z","isPatch":true,"sender":{"key":"mhagger@alum.mit.edu","avatar":"https://avatars.githubusercontent.com/u/119718?v=4"},"body":"From: Michael Haggerty \n\nThe \"--add\" option is required to add a new value to a multivalued\nconfiguration entry.\n\nSigned-off-by: Michael Haggerty \n---\n Documentation/git-config.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 46775fe..584ef51 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -342,7 +342,7 @@ To actually match only values with an exclamation mark, you have to\n To add a new proxy, without altering any of the existing ones, use\n \n ------------\n-% git config core.gitproxy '\"proxy-command\" for example.com'\n+% git config --add core.gitproxy '\"proxy-command\" for example.com'\n ------------\n \n An example to use customized color from the configuration in your\n-- \n1.7.11.3\n"},{"id":"197263","messageId":"7v7gswrkvm.fsf@alter.siamese.dyndns.org","threadId":"31280","inReplyTo":"1345311130-20426-2-git-send-email-mhagger@alum.mit.edu","subject":"Re: [PATCH 1/2] git-config.txt: properly escape quotation marks in example","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-08-18T20:43:57Z","receivedAt":"2012-08-18T20:43:57Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"mhagger@alum.mit.edu writes:\n\n> From: Michael Haggerty \n>\n> In the example line as written,\n>\n> gitproxy=\"proxy-command\" for kernel.org\n>\n> the quotation marks are eaten by the config-file parser. From the\n> history, it looks like this example wanted to have quotation marks in\n> the actual configured value. So quote them as required nowadays.\n>\n> Signed-off-by: Michael Haggerty \n> ---\n>\n> The bigger question is whether this example is improved by including\n> quotation marks, or whether they are just a distraction from the main\n> point. I abstain.\n\nThanks for spelling that bigger question out. Given that the\nexample is showing distinction between \"X\" vs \"X for Y\", I would say\nquotation is a distraction.\n\nIf you spelled it as\n\n\t[core]\n \tgitproxy = sh -c 'proxy-command' for kernel.org\n\ndoes the do the right thing? Or do we require the above to be\nspelled as\n\n\t[core]\n \tgitproxy = \\\"sh -c 'proxy-command'\\\" for kernel.org\n\nto work correctly? I suspect that the former would work, and in\nthat case, the quote around \"proxy-command\" in the documentation is\nindeed a distraction, and removing it will not hurt the readers.\n\n> Documentation/git-config.txt | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\n> index 2d6ef32..46775fe 100644\n> --- a/Documentation/git-config.txt\n> +++ b/Documentation/git-config.txt\n> @@ -267,7 +267,7 @@ Given a .git/config like this:\n> \n> \t; Proxy settings\n> \t[core]\n> -\t\tgitproxy=\"proxy-command\" for kernel.org\n> +\t\tgitproxy=\\\"proxy-command\\\" for kernel.org\n> \t\tgitproxy=default-proxy ; for all the rest\n> \n> you can set the filemode to true with\n"},{"id":"197265","messageId":"7v393krktg.fsf@alter.siamese.dyndns.org","threadId":"31280","inReplyTo":"1345311130-20426-3-git-send-email-mhagger@alum.mit.edu","subject":"Re: [PATCH 2/2] git-config.txt: fix example","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-08-18T20:45:15Z","receivedAt":"2012-08-18T20:45:15Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"mhagger@alum.mit.edu writes:\n\n> To add a new proxy, without altering any of the existing ones, use\n> \n> ------------\n> -% git config core.gitproxy '\"proxy-command\" for example.com'\n> +% git config --add core.gitproxy '\"proxy-command\" for example.com'\n> ------------\n\nSensible; thanks.\n"},{"id":"197271","messageId":"7vmx1rrcr4.fsf@alter.siamese.dyndns.org","threadId":"31280","inReplyTo":"7v7gswrkvm.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH 1/2] git-config.txt: properly escape quotation marks in example","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-08-18T23:39:27Z","receivedAt":"2012-08-18T23:39:27Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Junio C Hamano writes:\n\n>> The bigger question is whether this example is improved by including\n>> quotation marks, or whether they are just a distraction from the main\n>> point. I abstain.\n>\n> Thanks for spelling that bigger question out. Given that the\n> example is showing distinction between \"X\" vs \"X for Y\", I would say\n> quotation is a distraction.\n>\n> If you spelled it as\n>\n> \t[core]\n> \tgitproxy = sh -c 'proxy-command' for kernel.org\n>\n> does the do the right thing? Or do we require the above to be\n> spelled as\n>\n> \t[core]\n> \tgitproxy = \\\"sh -c 'proxy-command'\\\" for kernel.org\n>\n> to work correctly?\n\nI think the answer is \"no\", there is no way to specify anything\nother than a \"path to the command\" for gitproxy. So I think we\nshould do this instead:\n\n-- >8 --\nSubject: [PATCH] git-config doc: unconfuse an example\n\nOne fictitious command \"proxy-command\" is enclosed inside a double\nquote pair, while another fictitious command \"default-proxy\" is not\nin the example, but the quoting does not change anything in the pair\nof examples. Remove the quotes to avoid unnecessary confusion.\n\nNoticed by Michael Haggerty.\n\nSigned-off-by: Junio C Hamano \n---\n Documentation/git-config.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 5382753..b24faa8 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -251,7 +251,7 @@ Given a .git/config like this:\n \n \t; Proxy settings\n \t[core]\n-\t\tgitproxy=\"proxy-command\" for kernel.org\n+\t\tgitproxy=proxy-command for kernel.org\n \t\tgitproxy=default-proxy ; for all the rest\n \n you can set the filemode to true with\n-- \n1.7.12.rc3.96.g0dba3eb\n"},{"id":"197280","messageId":"5030B2E1.5020102@alum.mit.edu","threadId":"31280","inReplyTo":"7vmx1rrcr4.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH 1/2] git-config.txt: properly escape quotation marks in example","fromName":"Michael Haggerty","fromEmail":"mhagger@alum.mit.edu","sentAt":"2012-08-19T09:33:21Z","receivedAt":"2012-08-19T09:33:21Z","isPatch":true,"sender":{"key":"mhagger@alum.mit.edu","avatar":"https://avatars.githubusercontent.com/u/119718?v=4"},"body":"On 08/19/2012 01:39 AM, Junio C Hamano wrote:\n> Junio C Hamano writes:\n>\n>>> The bigger question is whether this example is improved by including\n>>> quotation marks, or whether they are just a distraction from the main\n>>> point. I abstain.\n>>\n>> Thanks for spelling that bigger question out. Given that the\n>> example is showing distinction between \"X\" vs \"X for Y\", I would say\n>> quotation is a distraction.\n>> [...]\n>\n> I think the answer is \"no\", there is no way to specify anything\n> other than a \"path to the command\" for gitproxy. So I think we\n> should do this instead: [...]\n\nACK. Thanks.\n\nMichael\n\n-- \nMichael Haggerty\nmhagger@alum.mit.edu\nhttp://softwareswirl.blogspot.com/\n"}]}