git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Moy Matthieu <Matthieu.Moy@univ-lyon1.fr>
Cc: second.payre@gmail.com, git@vger.kernel.org,
	PAYRE NATHAN p1508475 <nathan.payre@etu.univ-lyon1.fr>,
	Daniel Bensoussan <daniel.bensoussan--bohm@etu.univ-lyon1.fr>,
	Timothee Albertin <timothee.albertin@etu.univ-lyon1.fr>
Subject: Re: [PATCH v2] Documentation/git-config.txt: reword missleading sentence
Date: Fri, 13 Oct 2017 21:04:03 +0900	[thread overview]
Message-ID: <xmqqvajjuudo.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <q7h9infjmos9.fsf@orange.lip.ens-lyon.fr> (Moy Matthieu's message of "Fri, 13 Oct 2017 10:32:06 +0200")

Moy Matthieu <Matthieu.Moy@univ-lyon1.fr> 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.

  reply	other threads:[~2017-10-13 12:04 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-05  8:17 [PATCH] Documentation/git-config.txt: reword missleading sentence PAYRE NATHAN p1508475
2017-10-05 10:13 ` Junio C Hamano
2017-10-10  8:19   ` Nathan PAYRE
2017-10-10  8:48     ` Junio C Hamano
2017-10-12  9:17       ` [PATCH v2] " second.payre
2017-10-13  0:23         ` Junio C Hamano
2017-10-13  8:32           ` Moy Matthieu
2017-10-13 12:04             ` Junio C Hamano [this message]
2017-10-18 20:27               ` [PATCH v3] " PAYRE NATHAN p1508475
2017-10-18 22:12                 ` Jonathan Nieder
2017-10-19  4:58                   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqvajjuudo.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox.com \
    --cc=Matthieu.Moy@univ-lyon1.fr \
    --cc=daniel.bensoussan--bohm@etu.univ-lyon1.fr \
    --cc=git@vger.kernel.org \
    --cc=nathan.payre@etu.univ-lyon1.fr \
    --cc=second.payre@gmail.com \
    --cc=timothee.albertin@etu.univ-lyon1.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).