Re: [PATCH 1/2] git-config.txt: properly escape quotation marks in example

Junio C Hamano [off-list ref] writes:

quoted

The bigger question is whether this example is improved by including
quotation marks, or whether they are just a distraction from the main
point.  I abstain.

Thanks for spelling that bigger question out.  Given that the
example is showing distinction between "X" vs "X for Y", I would say
quotation is a distraction.

If you spelled it as

	[core]
        	gitproxy = sh -c 'proxy-command' for kernel.org

does the do the right thing?  Or do we require the above to be
spelled as

	[core]
        	gitproxy = \"sh -c 'proxy-command'\" for kernel.org

to work correctly?

I think the answer is "no", there is no way to specify anything
other than a "path to the command" for gitproxy.  So I think we
should do this instead:

-- >8 --
Subject: [PATCH] git-config doc: unconfuse an example

One fictitious command "proxy-command" is enclosed inside a double
quote pair, while another fictitious command "default-proxy" is not
in the example, but the quoting does not change anything in the pair
of examples.  Remove the quotes to avoid unnecessary confusion.

Noticed by Michael Haggerty.

Signed-off-by: Junio C Hamano <redacted>
---
 Documentation/git-config.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 5382753..b24faa8 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt

@@ -251,7 +251,7 @@ Given a .git/config like this:
 
 	; Proxy settings
 	[core]
-		gitproxy="proxy-command" for kernel.org
+		gitproxy=proxy-command for kernel.org
 		gitproxy=default-proxy ; for all the rest
 
 you can set the filemode to true with

-- 
1.7.12.rc3.96.g0dba3eb

On 08/19/2012 01:39 AM, Junio C Hamano wrote:

Junio C Hamano [off-list ref] writes:

quoted

quoted

The bigger question is whether this example is improved by including
quotation marks, or whether they are just a distraction from the main
point.  I abstain.

Thanks for spelling that bigger question out.  Given that the
example is showing distinction between "X" vs "X for Y", I would say
quotation is a distraction.
[...]

I think the answer is "no", there is no way to specify anything
other than a "path to the command" for gitproxy.  So I think we
should do this instead:  [...]

ACK.  Thanks.

Michael

-- 
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/