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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Moy Matthieu <Matthieu.Moy@xxxxxxxxxxxxx> 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.



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux