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

[Junio C Hamano]

Moy Matthieu  writes:

>>>  --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
>
> Didn't notice yesterday, but you still have forward quotes here and
> backquotes right below. If you are to fix this paragraph, better fix all
> issues at once.

When we say ~user in this sentence, unlike $HOME, it is not
something the user would type literally; 'user' in that is a
placeholder to be replaced with a value appropriate in the real
life, e.g. ~moy.  So '{tilde}user' may actually be OK, even though I
agree that `$HOME` may be more correct.

>>> 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?  ...
>
> If I read correctly, the potential issue with ~ is that it's used for
> subscript text (i.e. foo~bar~ in asciidoc is LaTeX's $foo_{bar}$). But ~
> within a literal string should be safe, and at least we use it in many
> places in our doc.

My comment was not about "safety" but about correctness.  At least
for me, `{tilde}user` does not expand to ~user, but instead spell
out open-brace, tee, eye, ..., close-brace, followed by "user",
which is not what we want.

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

[Moy Matthieu]

Junio C Hamano  writes:

> second.pa...@gmail.com writes:
>
>> From: PAYRE NATHAN p1508475 
>
> 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?

Yes, I'd rather have contributions made with the identity
@etu.univ-lyon1.fr, and use the same identity for Signed-off-by: and
From:.

>>  --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

Didn't notice yesterday, but you still have forward quotes here and
backquotes right below. If you are to fix this paragraph, better fix all
issues at once.

>>  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}`.

If I read correctly, the potential issue with ~ is that it's used for
subscript text (i.e. foo~bar~ in asciidoc is LaTeX's $foo_{bar}$). But ~
within a literal string should be safe, and at least we use it in many
places in our doc.

Cheers,

-- 
Matthieu Moy
https://matthieu-moy.fr/

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

[Junio C Hamano]

second.pa...@gmail.com writes:

> From: PAYRE NATHAN p1508475 

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.

> 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.sl92grzcqtrv9oqkbfpe...@crashcourse.ca/
>
> Signed-off-by: MOY Matthieu 
> Signed-off-by: Daniel Bensoussan 
> Signed-off-by: Timothee Albertin 
> Signed-off-by: Nathan Payre 
> Noticed-by: rpj...@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 <>.
>   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::

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

[second . payre]

From: PAYRE NATHAN p1508475 

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.sl92grzcqtrv9oqkbfpe...@crashcourse.ca/

Signed-off-by: MOY Matthieu 
Signed-off-by: Daniel Bensoussan 
Signed-off-by: Timothee Albertin 
Signed-off-by: Nathan Payre 
Noticed-by: rpj...@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 <>.
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}/`
+   from the command line to let your shell do the expansion).
 
 -z::
 --null::
-- 
2.14.2