aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/pretty-options.txt
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2021-10-29 17:10:03 -0400
committerJunio C Hamano <gitster@pobox.com>2021-10-29 14:35:59 -0700
commit9e8fe7b1c789fee4b7d0b219180cd26de80d730e (patch)
tree177617c82b9253ed39c10d0b39e4720b4b6e8fa7 /Documentation/pretty-options.txt
parent0988e665e936d0c2c861dcd652bff9817e9446bf (diff)
downloadgit-9e8fe7b1c789fee4b7d0b219180cd26de80d730e.tar.gz
log: document --encoding behavior on iconv() failure
We already note that we may produce invalid output when we skip calling iconv() altogether. But we may also do so if iconv() fails, and we have no good alternative. Let's document this to avoid surprising users. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/pretty-options.txt')
-rw-r--r--Documentation/pretty-options.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 54d8bb3db0..dc685be363 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -40,7 +40,9 @@ people using 80-column terminals.
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 quietly output the original
+ object verbatim.
--expand-tabs=<n>::
--expand-tabs::