Re: [PATCH v2] Documentation/git-config.txt: reword missleading sentence

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 13, 2017, 00:23 UTC
Message-ID: <xmqqa80vyjyf.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20171012091727.30759-1-second.payre@gmail.com>

second.payre@gmail.com writes:

> From: PAYRE NATHAN p1508475 <nathan.payre@etu.univ-lyon1.fr>

Should I assume that the name/address on the last Signed-off-by: we see below is what you want to be known as? As a part of school work, I'd imagine that Matthieu wants your work to be associated with the univ-lyon1.fr address, so perhaps you want to go the other way around? It's not my place to decide between the two, but it is unusual to see that the name/address of the author (which is the above line) does not match what is on the Signed-off-by: line.

Show 39 quoted lines

> Change the word "bla" to "section.variable", "bla" is a placeholder
> for a variable name and it wasn't clear for everyone.
> This change clarify it.
>
> Change the appearance of 'git config section.variable {tilde}/' to
> `git config section.variable {tilde}/` to harmonize it with
> the rest of the file, this is a command line then the "`" are
> necessary.
>
> Replace "git-config" by "git config" because the command
> is not "git-config".
>
> See discussion at:
> https://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/
>
> Signed-off-by: MOY Matthieu <matthieu.moy@univ-lyon1.fr>
> Signed-off-by: Daniel Bensoussan <daniel.bensoussan--bohm@etu.univ-lyon1.fr>
> Signed-off-by: Timothee Albertin <timothee.albertin@etu.univ-lyon1.fr>
> Signed-off-by: Nathan Payre <second.payre@gmail.com>
> Noticed-by: rpjday@crashcourse.ca
> ---
>  Documentation/git-config.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> index 83f86b923..2ab9e4c56 100644
> --- a/Documentation/git-config.txt
> +++ b/Documentation/git-config.txt
> @@ -174,11 +174,11 @@ See also <<FILES>>.
>  	either --bool or --int, as described above.
>  
>  --path::
> -	'git-config' will expand leading '{tilde}' to the value of
> +	'git config' will expand leading '{tilde}' to the value of
>  	'$HOME', and '{tilde}user' to the home directory for the
>  	specified user.  This option has no effect when setting the
> -	value (but you can use 'git config bla {tilde}/' from the
> -	command line to let your shell do the expansion).
> +	value (but you can use `git config section.variable {tilde}/`

Does this reference to {tilde} get expanded inside the `literal` mark-up? In the description for 'gitdir', we find this passage (in Documentation/config.txt):

     * If the pattern starts with `~/`, `~` will be substituted with the
       content of the environment variable `HOME`.

So I'd expect `~` to be a safe way to get what you want, not `{tilde}`.

> +	from the command line to let your shell do the expansion).
>  
>  -z::
>  --null::