git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
To: Jeff King <peff@peff.net>
Cc: "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] connect: read $GIT_SSH_COMMAND from config file
Date: Tue, 28 Jun 2016 10:35:52 +0200	[thread overview]
Message-ID: <vpqwpl9yal3.fsf@anie.imag.fr> (raw)
In-Reply-To: <20160627193322.GB10877@sigill.intra.peff.net> (Jeff King's message of "Mon, 27 Jun 2016 15:33:23 -0400")

Jeff King <peff@peff.net> writes:

> On Sun, Jun 26, 2016 at 01:16:35PM +0200, Nguyễn Thái Ngọc Duy wrote:
>
>> +	use the specified command instead of 'ssh' when they need to
>> +	connect to a remote system. The command is in the same form as
>> +	'GIT_SSH_COMMAND' environment variable and is overriden when
>> +	the environment variable is set.
>
> Probably s/'GIT_SSH_COMMAND'/the &/.

I think so. I'd write either "same form as `GIT_SSH_COMMAND`" or "same
form as the `GIT_SSH_COMMAND` environment variable`.

> Are we using backticks for typesetting environment variables now? That
> has always been my preference, but I haven't kept up with the typography
> patches that have been flying lately. +cc Matthieu.

Yes, we've tried to make the docs a bit more consistant, and to document
that better in Documentation/CodingGuidelines:

 An environment variable must be prefixed with "$" only when referring to its
 value and not when referring to the variable itself, in this case there is
 nothing to add except the backticks:
   `GIT_DIR` is specified
   `$GIT_DIR/hooks/pre-receive`

> (Similar question for commands like 'git fetch').

Backticks too:

   Literal examples (e.g. use of command-line options, command names,
 branch names, configuration and environment variables) must be
 typeset in monospace (i.e. wrapped with backticks):
   `--pretty=oneline`
   `git rev-list`

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

  reply	other threads:[~2016-06-28  8:36 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-06-26 11:16 [PATCH] connect: read $GIT_SSH_COMMAND from config file Nguyễn Thái Ngọc Duy
2016-06-27 19:33 ` Jeff King
2016-06-28  8:35   ` Matthieu Moy [this message]
2016-06-28 17:58     ` Junio C Hamano
2016-06-28 19:01       ` Eric Sunshine

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=vpqwpl9yal3.fsf@anie.imag.fr \
    --to=matthieu.moy@grenoble-inp.fr \
    --cc=git@vger.kernel.org \
    --cc=pclouds@gmail.com \
    --cc=peff@peff.net \
    /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).