git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Jeff King <peff@peff.net>
Cc: douglas.fuller@gmail.com, git@vger.kernel.org
Subject: Re: [PATCH] doc: fix quoting bug in credential cache example
Date: Thu, 30 Apr 2020 23:20:52 -0700	[thread overview]
Message-ID: <xmqq368kp457.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <20200501055738.GB23665@coredump.intra.peff.net> (Jeff King's message of "Fri, 1 May 2020 01:57:38 -0400")

Jeff King <peff@peff.net> writes:

> I think we can either clarify that with a note at the beginning of the
> list, or we can just present it as config, like:
>
> diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
> index 1814d2d23c..c756ecb8fd 100644
> --- a/Documentation/gitcredentials.txt
> +++ b/Documentation/gitcredentials.txt
> @@ -216,20 +216,25 @@ Here are some example specifications:
>  
>  ----------------------------------------------------
>  # run "git credential-foo"
> -foo
> +[credential]
> +helper = foo

I like this style of "clarification"; it makes it clear that we are
explaining the value in the config-file syntax.

>  # or you can specify your own shell snippet
> -!f() { echo "password=`cat $HOME/.secret`"; }; f
> +[credential]
> +helper = "!f() { echo \"password=`cat $HOME/.secret`\"; }; f"

But I do not think the "tentative shell function" trick is
necessary.  I personally think it is oversold ;-)  For this
particular one,

    [credential]
        helper = !echo \"password=`cat $HOME/.secret`\"

should be sufficient, perhaps?  You do not even need to understand
how shell functions work to understand it.

Also, "git config" indents the "var = value" lines, so it would look
more natural if we indented our examples in a similar way.

Thanks.

  parent reply	other threads:[~2020-05-01  6:21 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-30 14:36 [PATCH] doc: fix quoting bug in credential cache example douglas.fuller
2020-04-30 18:09 ` Junio C Hamano
2020-05-01  5:57   ` Jeff King
2020-05-01  6:19     ` Jeff King
2020-05-01  6:20       ` [PATCH 1/2] gitcredentials(7): clarify quoting of helper examples Jeff King
2020-05-01  7:19         ` Andreas Schwab
2020-05-01  7:31           ` Jeff King
2020-05-01  6:23       ` [PATCH 2/2] gitcredentials(7): make shell-snippet example more realistic Jeff King
2020-05-01  6:26         ` Junio C Hamano
2020-05-01  6:32           ` Jeff King
2020-05-01  6:35             ` Jeff King
2020-05-01  7:32               ` Jeff King
2020-05-01  7:33                 ` [PATCH v2 1/2] gitcredentials(7): clarify quoting of helper examples Jeff King
2020-05-01  7:33                 ` [PATCH v2 2/2] gitcredentials(7): make shell-snippet example more realistic Jeff King
2020-05-01 15:11               ` [PATCH " Junio C Hamano
2020-05-01 14:40       ` [PATCH] doc: fix quoting bug in credential cache example douglas.fuller
2020-05-01  6:20     ` Junio C Hamano [this message]
2020-05-01  6:25       ` Jeff King

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=xmqq368kp457.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=douglas.fuller@gmail.com \
    --cc=git@vger.kernel.org \
    --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).