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>
Jeff King committed
Oct 29, 2021 at 17:10 UTC
9e8fe7b1c789fee4b7d0b219180cd26de80d730e
1 file changed
+3
-1
Documentation/pretty-options.txt
+3
-1
@@ -40,7 +40,9 @@ people using 80-column terminals.
40
defaults to UTF-8. Note that if an object claims to be encoded
41
in `X` and we are outputting in `X`, we will output the object
42
verbatim; this means that invalid sequences in the original
43
- commit may be copied to the output.
43
+ commit may be copied to the output. Likewise, if iconv(3) fails
44
+ to convert the commit, we will quietly output the original
45
+ object verbatim.
46
47
--expand-tabs=<n>::
48
--expand-tabs::