git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Andreas Heiduk <asheiduk@gmail.com>
To: gitster@pobox.com
Cc: Andreas Heiduk <asheiduk@gmail.com>, git@vger.kernel.org
Subject: [PATCH v2 1/2] Documentation: Improve description for core.quotePath
Date: Fri, 24 Feb 2017 21:37:55 +0100	[thread overview]
Message-ID: <1487968676-6126-2-git-send-email-asheiduk@gmail.com> (raw)
In-Reply-To: <1487968676-6126-1-git-send-email-asheiduk@gmail.com>

Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
---
 Documentation/config.txt | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1fee83c..fa06c2a 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -347,16 +347,20 @@ core.checkStat::
 	all fields, including the sub-second part of mtime and ctime.
 
 core.quotePath::
-	The commands that output paths (e.g. 'ls-files',
-	'diff'), when not given the `-z` option, will quote
-	"unusual" characters in the pathname by enclosing the
-	pathname in a double-quote pair and with backslashes the
-	same way strings in C source code are quoted.  If this
-	variable is set to false, the bytes higher than 0x80 are
-	not quoted but output as verbatim.  Note that double
-	quote, backslash and control characters are always
-	quoted without `-z` regardless of the setting of this
-	variable.
+
+	Commands that output paths (e.g. 'ls-files', 'diff'), will
+	quote "unusual" characters in the pathname by enclosing the
+	pathname in double-quotes and escaping those characters with
+	backslashes in the same way C escapes control characters (e.g.
+	`\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
+	values larger than 0x80 (e.g. octal `\302\265` for "micro" in
+	UTF-8).  If this variable is set to false, bytes higher than
+	0x80 are not considered "unusual" any more. Double-quotes,
+	backslash and control characters are always escaped regardless
+	of the setting of this variable.  A simple space character is
+	not considered "unusual".  Many commands can output pathnames
+	completely verbatim using the `-z` option. The default value
+	is true.
 
 core.eol::
 	Sets the line ending type to use in the working directory for

  reply	other threads:[~2017-02-24 20:38 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-02-19 22:05 [PATCH] Documentation: Link git-ls-files to core.quotePath variable Andreas Heiduk
2017-02-21 20:48 ` Junio C Hamano
2017-02-22  1:20   ` Andreas Heiduk
2017-02-22  1:38   ` Andreas Heiduk
2017-02-22 12:21     ` Philip Oakley
2017-02-22 21:02       ` Junio C Hamano
2017-02-22 21:08         ` Andreas Heiduk
2017-02-24 20:37           ` [PATCH v2 0/2] " Andreas Heiduk
2017-02-24 20:37             ` Andreas Heiduk [this message]
2017-02-24 21:43               ` [PATCH v2 1/2] Documentation: Improve description for core.quotePath Jakub Narębski
2017-02-28 20:55                 ` Andreas Heiduk
2017-02-24 20:37             ` [PATCH v2 2/2] Documentation: Link descriptions of -z to core.quotePath Andreas Heiduk
2017-02-24 21:54               ` Jakub Narębski
2017-02-28 21:30                 ` Andreas Heiduk
2017-02-28 20:51               ` Junio C Hamano
2017-02-28 21:13                 ` Andreas Heiduk
2017-02-28 21:25                   ` Junio C Hamano
2017-02-22 17:41     ` [PATCH] Documentation: Link git-ls-files to core.quotePath variable 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=1487968676-6126-2-git-send-email-asheiduk@gmail.com \
    --to=asheiduk@gmail.com \
    --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.
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).