Re: [PATCH] doc: fix quoting bug in credential cache example

From: douglas.fuller@gmail.com <douglas.fuller@gmail.com>
Date: May 1, 2020, 14:40 UTC
Message-ID: <448114a7ab365f81971bfd9dd75b781f4145b098.camel@gmail.com>
In-Reply-To: <20200501061917.GC23665@coredump.intra.peff.net>

On Fri, 2020-05-01 at 02:19 -0400, Jeff King wrote:

Show 12 quoted lines

> On Fri, May 01, 2020 at 01:57:38AM -0400, Jeff King wrote:
> 
> > It may be easier to just use double-quotes consistently, even for
> > ones
> > that do not need it, to give readers one less thing to wonder
> > about.
> 
> So here's a patch that does that. I also noticed a few other
> deficiencies in that final example, which are fixed in the second
> patch.
> 
> I hope I'm not stealing Douglas's thunder. :)

My one-line patch definitely wasn't thunderous -- I didn't even know how to write a comment in a config file. As posited upthread, I did interpret the example as presenting config file syntax, so I got tripped up by the semicolon there. This patch makes it more clear.

I use git (thanks!) without having looked at the code, so I figured I was a good example of the target audience for this doc. Thanks for making it more clear.

Cheers, --Doug

Show 7 quoted lines

>   [1/2]: gitcredentials(7): clarify quoting of helper examples
>   [2/2]: gitcredentials(7): make shell-snippet example more realistic
> 
>  Documentation/gitcredentials.txt | 16 +++++++++++-----
>  1 file changed, 11 insertions(+), 5 deletions(-)
> 
> -Peff