Re: gitrevisions: be more chatty about shell metacharacter gotchas?
On Mon, Dec 2, 2024, at 02:26, Junio C Hamano wrote:
Show 29 quoted lines
> There already is a note about '*'; we can add another note about
> whitespace next to it, perhaps here.
>
> Documentation/gitcli.txt | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>
> diff --git c/Documentation/gitcli.txt w/Documentation/gitcli.txt
> index 7c709324ba..0a67005fc6 100644
> --- c/Documentation/gitcli.txt
> +++ w/Documentation/gitcli.txt
> @@ -57,6 +57,16 @@ When writing a script that is expected to handle
> random user-input, it is
> a good practice to make it explicit which arguments are which by
> placing
> disambiguating `--` at appropriate places.
>
> + * Arguments, options, and option values given on the shell command
> + line follow the usual shell syntax rules. You'd need to quote
> + your string with whitespace in it appropriately if you do not
> + want it to be split by the shell, for example.
> ++
> +--------------------------------
> +$ git commit -m "my message with whitespace"
> +$ git show "HEAD^{/^my message with whitespace}"
> +--------------------------------
> +
> * Many commands allow wildcards in paths, but you need to protect
> them from getting globbed by the shell. These two mean different
> things:This is a good addition. Including a couple of good examples.
--
Kristoffer Haugsbakk