From: Christopher Yeleighton <redacted>
Please fix the manual for git log. It should say what encoding is recognised
(namely if supported by iconv(1), except that POSIX character maps of
iconv(1p) are not supported), and that an unrecognised encoding is ignored.
Signed-off-by: <redacted>
---
log: describe supported encoding
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1079%2Fyecril71pl%2Fpatch-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1079/yecril71pl/patch-1-v1
Pull-Request: https://github.com/git/git/pull/1079
Documentation/pretty-options.txt | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 27ddaf84a19..4f8376d681b 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -36,9 +36,13 @@ people using 80-column terminals.
The commit objects record the encoding used for the log message
in their encoding header; this option can be used to tell the
command to re-code the commit log message in the encoding
- preferred by the user. For non plumbing commands this
- defaults to UTF-8. Note that if an object claims to be encoded
- in `X` and we are outputting in `X`, we will output the object
+ preferred by the user.
+ The encoding must be a system encoding supported by iconv(1),
+ otherwise this option will be ignored.
+ POSIX character maps used by iconv(1p) are not supported.
+ For non-plumbing commands this defaults to UTF-8.
+ Note that if an object claims to be encoded in `X`
+ and we are outputting in `X`, we shall output the object
verbatim; this means that invalid sequences in the original
commit may be copied to the output.
base-commit: c4203212e360b25a1c69467b5a8437d45a373cac
--
gitgitgadget
On 27/08/21 04.34, Christopher Yeleighton via GitGitGadget wrote:
From: Christopher Yeleighton <redacted>
Please fix the manual for git log. It should say what encoding is recognised
(namely if supported by iconv(1), except that POSIX character maps of
iconv(1p) are not supported), and that an unrecognised encoding is ignored.
Signed-off-by: <redacted>
---
The commit message should be:
"git log recognizes only system encodings supported by iconv(1), but not
POSIX character maps used by iconv(1p). Document it.".
The commit objects record the encoding used for the log message
in their encoding header; this option can be used to tell the
command to re-code the commit log message in the encoding
- preferred by the user. For non plumbing commands this
- defaults to UTF-8. Note that if an object claims to be encoded
- in `X` and we are outputting in `X`, we will output the object
+ preferred by the user.
+ The encoding must be a system encoding supported by iconv(1),
+ otherwise this option will be ignored.
+ POSIX character maps used by iconv(1p) are not supported.
+ For non-plumbing commands this defaults to UTF-8.
+ Note that if an object claims to be encoded in `X`
+ and we are outputting in `X`, we shall output the object
verbatim; this means that invalid sequences in the original
commit may be copied to the output.
I think POSIX character maps and encoding are the same, what are their
differences? Reading iconv(1p) [1] doesn't give definition of the former.
[1]: https://man7.org/linux/man-pages/man1/iconv.1p.html
--
An old man doll... just what I always wanted! - Clara
Dnia piątek, 27 sierpnia 2021 12:46:22 CEST Bagas Sanjaya pisze:
I think POSIX character maps and encoding are the same, what are their
differences? Reading iconv(1p) [1] doesn't give definition of the former.
[1]: https://man7.org/linux/man-pages/man1/iconv.1p.html
System encoding providers are code, POSIX character maps are data.
Chris
git log recognises only system encodings supported by iconv(1), but not
POSIX character maps used by iconv(1p). Document it.
Signed-off-by: <redacted>
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-
options.txt
index 27ddaf84a19..4f8376d681b 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -36,9 +36,13 @@ people using 80-column terminals.
The commit objects record the encoding used for the log message
in their encoding header; this option can be used to tell the
command to re-code the commit log message in the encoding
- preferred by the user. For non plumbing commands this
- defaults to UTF-8. Note that if an object claims to be encoded
- in `X` and we are outputting in `X`, we will output the object
+ preferred by the user.
+ The encoding must be a system encoding supported by iconv(1),
+ otherwise this option will be ignored.
+ POSIX character maps used by iconv(1p) are not supported.
+ For non-plumbing commands this defaults to UTF-8.
+ Note that if an object claims to be encoded in `X`
+ and we are outputting in `X`, we shall output the object
verbatim; this means that invalid sequences in the original
commit may be copied to the output.