From: "Jakub Narębski" <jnareb@gmail.com>
To: Andreas Heiduk <asheiduk@gmail.com>, Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH v2 2/2] Documentation: Link descriptions of -z to core.quotePath
Date: Fri, 24 Feb 2017 22:54:35 +0100 [thread overview]
Message-ID: <f534b9c7-c8a8-1a05-5fcb-020122dccaac@gmail.com> (raw)
In-Reply-To: <1487968676-6126-3-git-send-email-asheiduk@gmail.com>
W dniu 24.02.2017 o 21:37, Andreas Heiduk pisze:
> Linking the description for pathname quoting to the configuration
> variable "core.quotePath" removes inconstistent and incomplete
> sections while also giving two hints how to deal with it: Either with
> "-c core.quotePath=false" or with "-z".
This patch I am not sure about. On one hand it improves consistency
(and makes information more complete), on the other hand it removes
information at hand and instead refers to other manpage.
Perhaps a better solution would be to craft a short description that
is both sufficiently complete, and refers to "core.quotePath" for
more details, and then transclude it with "include::quotepath.txt[]".
>
> Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
> ---
> Documentation/diff-format.txt | 7 ++++---
> Documentation/diff-generate-patch.txt | 7 +++----
> Documentation/diff-options.txt | 7 +++----
> Documentation/git-apply.txt | 7 +++----
> Documentation/git-commit.txt | 9 ++++++---
> Documentation/git-ls-files.txt | 10 ++++++----
> Documentation/git-ls-tree.txt | 10 +++++++---
> Documentation/git-status.txt | 7 +++----
> 8 files changed, 35 insertions(+), 29 deletions(-)
>
> diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt
> index cf52626..706916c 100644
> --- a/Documentation/diff-format.txt
> +++ b/Documentation/diff-format.txt
> @@ -78,9 +78,10 @@ Example:
> :100644 100644 5be4a4...... 000000...... M file.c
> ------------------------------------------------
>
> -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.
>
> diff format for merges
> ----------------------
> diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
> index d2a7ff5..231105c 100644
> --- a/Documentation/diff-generate-patch.txt
> +++ b/Documentation/diff-generate-patch.txt
> @@ -53,10 +53,9 @@ The index line includes the SHA-1 checksum before and after the change.
> The <mode> is included if the file mode does not change; otherwise,
> separate lines indicate the old and the new mode.
>
> -3. TAB, LF, double quote and backslash characters in pathnames
> - are represented as `\t`, `\n`, `\"` and `\\`, respectively.
> - If there is need for such substitution then the whole
> - pathname is put in double quotes.
> +3. Pathnames with "unusual" characters are quoted as explained for
> + the configuration variable `core.quotePath` (see
> + linkgit:git-config[1]).
>
> 4. All the `file1` files in the output refer to files before the
> commit, and all the `file2` files refer to files after the commit.
> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
> index e6215c3..7c28e73 100644
> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -192,10 +192,9 @@ ifndef::git-log[]
> given, do not munge pathnames and use NULs as output field terminators.
> endif::git-log[]
> +
> -Without this option, each pathname output will have TAB, LF, double quotes,
> -and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
> -respectively, and the pathname will be enclosed in double quotes if
> -any of those replacements occurred.
> +Without this option, pathnames with "unusual" characters are munged as
> +explained for the configuration variable `core.quotePath` (see
> +linkgit:git-config[1]).
>
> --name-only::
> Show only names of changed files.
> diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
> index 8ddb207..a7a001b 100644
> --- a/Documentation/git-apply.txt
> +++ b/Documentation/git-apply.txt
> @@ -108,10 +108,9 @@ the information is read from the current index instead.
> When `--numstat` has been given, do not munge pathnames,
> but use a NUL-terminated machine-readable format.
> +
> -Without this option, each pathname output will have TAB, LF, double quotes,
> -and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
> -respectively, and the pathname will be enclosed in double quotes if
> -any of those replacements occurred.
> +Without this option, pathnames with "unusual" characters are munged as
> +explained for the configuration variable `core.quotePath` (see
> +linkgit:git-config[1]).
>
> -p<n>::
> Remove <n> leading slashes from traditional diff paths. The
> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> index 4f8f20a..25dcdcc 100644
> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -117,9 +117,12 @@ OPTIONS
>
> -z::
> --null::
> - When showing `short` or `porcelain` status output, terminate
> - entries in the status output with NUL, instead of LF. If no
> - format is given, implies the `--porcelain` output format.
> + When showing `short` or `porcelain` status output, print the
> + filename verbatim and terminate the entries with NUL, instead of LF.
> + If no format is given, implies the `--porcelain` output format.
> + Without the `-z` option, filenames with "unusual" characters are
> + quoted as explained for the configuration variable `core.quotePath`
> + (see linkgit:git-config[1]).
>
> -F <file>::
> --file=<file>::
> diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
> index 446209e..1cab703 100644
> --- a/Documentation/git-ls-files.txt
> +++ b/Documentation/git-ls-files.txt
> @@ -77,7 +77,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>::
> @@ -196,9 +197,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
> diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
> index dbc91f9..9dee7be 100644
> --- a/Documentation/git-ls-tree.txt
> +++ b/Documentation/git-ls-tree.txt
> @@ -53,7 +53,8 @@ OPTIONS
> Show object size of blob (file) entries.
>
> -z::
> - \0 line termination on output.
> + \0 line termination on output and do not quote filenames.
> + See OUTPUT FORMAT below for more information.
>
> --name-only::
> --name-status::
> @@ -82,8 +83,6 @@ Output Format
> -------------
> <mode> SP <type> SP <object> TAB <file>
>
> -Unless the `-z` option is used, TAB, LF, and backslash characters
> -in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
> This output format is compatible with what `--index-info --stdin` of
> 'git update-index' expects.
>
> @@ -95,6 +94,11 @@ Object size identified by <object> is given in bytes, and right-justified
> with minimum width of 7 characters. Object size is given only for blobs
> (file) entries; for other entries `-` character is used in place of size.
>
> +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.
> +
> GIT
> ---
> Part of the linkgit:git[1] suite
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index 725065e..ba87365 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -322,10 +322,9 @@ When the `-z` option is given, pathnames are printed as is and
> without any quoting and lines are terminated with a NUL (ASCII 0x00)
> byte.
>
> -Otherwise, all pathnames will be "C-quoted" if they contain any tab,
> -linefeed, double quote, or backslash characters. In C-quoting, these
> -characters will be replaced with the corresponding C-style escape
> -sequences and the resulting pathname will be double quoted.
> +Without the `-z` option, pathnames with "unusual" characters are
> +quoted as explained for the configuration variable `core.quotePath`
> +(see linkgit:git-config[1]).
>
>
> CONFIGURATION
>
next prev parent reply other threads:[~2017-02-24 21:54 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 ` [PATCH v2 1/2] Documentation: Improve description for core.quotePath Andreas Heiduk
2017-02-24 21:43 ` 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 [this message]
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=f534b9c7-c8a8-1a05-5fcb-020122dccaac@gmail.com \
--to=jnareb@gmail.com \
--cc=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).