Re: [PATCH] Documentation: Link git-ls-files to core.quotePath variable.
From: Junio C Hamano <hidden>
Date: 2017-02-22 21:04:27
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2017-02-22 · Re: [PATCH] Documentation: Link git-ls-files to core.quotePath variable. · Philip Oakley <hidden>
- 2017-02-22 · Re: [PATCH] Documentation: Link git-ls-files to core.quotePath variable. · Junio C Hamano <hidden>
- 2017-02-22 · Re: [PATCH] Documentation: Link git-ls-files to core.quotePath variable. · Andreas Heiduk <hidden>
- 2017-02-22 · Re: [PATCH] Documentation: Link git-ls-files to core.quotePath variable. · Andreas Heiduk <hidden>
- 2017-02-21 · Re: [PATCH] Documentation: Link git-ls-files to core.quotePath variable. · Junio C Hamano <hidden>
"Philip Oakley" [off-list ref] writes:
quoted
-When `-z` option is not used, TAB, LF, and backslash characters -in pathnames are represented as `\t`, `\n`, and `\\`, -respectively. The path is also quoted according to the -configuration variable `core.quotePath` (see linkgit:git-config[1]). +Without the `-z` option pathnamens with "unusual" characters ares/option pathnamens/option, pathnames/ # comma and spelling.
Thanks. Will squash it in while queuing (I need to discard the new text added in the previous attempt in the preimage to make it apply, too). -- >8 -- From: Andreas Heiduk <redacted> Date: Wed, 22 Feb 2017 02:38:21 +0100 Subject: [PATCH] Documentation: clarify core.quotePath and update git-ls-files doc Signed-off-by: Andreas Heiduk <redacted> Signed-off-by: Junio C Hamano <redacted> --- Documentation/config.txt | 22 ++++++++++++---------- Documentation/git-ls-files.txt | 10 ++++++---- 2 files changed, 18 insertions(+), 14 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index f4721a048b..25e65aeb01 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt@@ -340,16 +340,18 @@ 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 `\265` for "micro"). 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. 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
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 078b556665..a415223b45 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt@@ -76,7 +76,8 @@ OPTIONS succeed. -z:: - \0 line termination on output. + \0 line termination on output and do not quote filenames. + See OUTPUT below for more information. -x <pattern>:: --exclude=<pattern>::
@@ -192,9 +193,10 @@ the index records up to three such pairs; one from tree O in stage the user (or the porcelain) to see what should eventually be recorded at the path. (see linkgit:git-read-tree[1] for more information on state) -When `-z` option is not used, TAB, LF, and backslash characters -in pathnames are represented as `\t`, `\n`, and `\\`, -respectively. +Without the `-z` option, pathnames with "unusual" characters are +quoted as explained for the configuration variable `core.quotePath` +(see linkgit:git-config[1]). Using `-z` the filename is output +verbatim and the line is terminated by a NUL byte. Exclude Patterns
--
2.12.0-rc2-250-gd33575c7f2