git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: mhagger@alum.mit.edu
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Michael Haggerty <mhagger@alum.mit.edu>
Subject: [PATCH 1/2] git-config.txt: properly escape quotation marks in example
Date: Sat, 18 Aug 2012 19:32:09 +0200	[thread overview]
Message-ID: <1345311130-20426-2-git-send-email-mhagger@alum.mit.edu> (raw)
In-Reply-To: <1345311130-20426-1-git-send-email-mhagger@alum.mit.edu>

From: Michael Haggerty <mhagger@alum.mit.edu>

In the example line as written,

        gitproxy="proxy-command" for kernel.org

the quotation marks are eaten by the config-file parser.  From the
history, it looks like this example wanted to have quotation marks in
the actual configured value.  So quote them as required nowadays.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---

The bigger question is whether this example is improved by including
quotation marks, or whether they are just a distraction from the main
point.  I abstain.

 Documentation/git-config.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 2d6ef32..46775fe 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -267,7 +267,7 @@ Given a .git/config like this:
 
 	; Proxy settings
 	[core]
-		gitproxy="proxy-command" for kernel.org
+		gitproxy=\"proxy-command\" for kernel.org
 		gitproxy=default-proxy ; for all the rest
 
 you can set the filemode to true with
-- 
1.7.11.3

  reply	other threads:[~2012-08-18 17:39 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-08-18 17:32 [PATCH 0/2] Fix two minor problems in the docs for git-config mhagger
2012-08-18 17:32 ` mhagger [this message]
2012-08-18 20:43   ` [PATCH 1/2] git-config.txt: properly escape quotation marks in example Junio C Hamano
2012-08-18 23:39     ` Junio C Hamano
2012-08-19  9:33       ` Michael Haggerty
2012-08-18 17:32 ` [PATCH 2/2] git-config.txt: fix example mhagger
2012-08-18 20:45   ` 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

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

  git send-email \
    --in-reply-to=1345311130-20426-2-git-send-email-mhagger@alum.mit.edu \
    --to=mhagger@alum.mit.edu \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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.
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 NNTP newsgroup(s).