diff options
author | Junio C Hamano <gitster@pobox.com> | 2021-09-10 11:46:30 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2021-09-10 11:46:30 -0700 |
commit | bfe37f3dc5a7750dd77c571ada91112b4389ffae (patch) | |
tree | 22e1e1c9d8d70ef5e3d6d2fedad594b3d73deb56 /Documentation | |
parent | Merge branch 'cb/remote-ndebug-fix' (diff) | |
parent | docs: use "character encoding" to refer to commit-object encoding (diff) | |
download | tgif-bfe37f3dc5a7750dd77c571ada91112b4389ffae.tar.xz |
Merge branch 'jk/log-warn-on-bogus-encoding'
Doc update plus improved error reporting.
* jk/log-warn-on-bogus-encoding:
docs: use "character encoding" to refer to commit-object encoding
logmsg_reencode(): warn when iconv() fails
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/config/gui.txt | 2 | ||||
-rw-r--r-- | Documentation/pretty-options.txt | 6 |
2 files changed, 5 insertions, 3 deletions
diff --git a/Documentation/config/gui.txt b/Documentation/config/gui.txt index d30831a130..0c087fd8c9 100644 --- a/Documentation/config/gui.txt +++ b/Documentation/config/gui.txt @@ -11,7 +11,7 @@ gui.displayUntracked:: in the file list. The default is "true". gui.encoding:: - Specifies the default encoding to use for displaying of + Specifies the default character encoding to use for displaying of file contents in linkgit:git-gui[1] and linkgit:gitk[1]. It can be overridden by setting the 'encoding' attribute for relevant files (see linkgit:gitattributes[5]). diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 27ddaf84a1..b3af850608 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -33,14 +33,16 @@ people using 80-column terminals. used together. --encoding=<encoding>:: - The commit objects record the encoding used for the log message + Commit objects record the character 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 verbatim; this means that invalid sequences in the original - commit may be copied to the output. + commit may be copied to the output. Likewise, if iconv(3) fails + to convert the commit, we will output the original object + verbatim, along with a warning. --expand-tabs=<n>:: --expand-tabs:: |