From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 24 Apr 2009 08:14:45 GMT
Subject: Re: [PATCH 1/3] rev-parse: add --sq-quote to shell quote arguments
Message-ID: <7v8wlqii2y.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <20090424062902.3705.44704.chriscool@tuxfamily.org>

Christian Couder <chriscool@tuxfamily.org> writes:

> @@ -30,6 +30,9 @@ OPTIONS
>  	Only meaningful in `--parseopt` mode. Tells the option parser to echo
>  	out the first `--` met instead of skipping it.
>  
> +--sq-quote::
> +	Use 'git-rev-parse' in shell quoting mode (see SQ-QUOTE section below).
> +

Hmph, I wonder how this interacts with the existing --sq option to the
same command in the mental model of end users.

> +Example
> +~~~~~~~
> +
> +------------
> +$ git rev-parse --sq-quote "'''" '"""' "arg with space"
> + ''\'''\'''\''' '"""' 'arg with space'
> +------------

Yuck --- does asciidoc formats this correctly?

    ... goes and tries ...

Not very readable.  A better example might be to demonstrate something
like this:

	$ cat >your-git-script.sh <<\EOF
	#!/bin/sh
	# quote user-supplied arguments
	args=$(git rev-parse --sq-quote "$@")
        # and use it inside a handcrafted command line
        command="git frotz -n24 $args"
        eval "$command"
	EOF

	$ sh your-git-script.sh "a b'c"

i.e, put stress on how to use it, not on how it works internally.