summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2015-06-17 14:46:08 -0400
committerJunio C Hamano <gitster@pobox.com>2015-06-17 13:46:36 -0700
commite479c5f8f380ea54353b96364f66a4496d213733 (patch)
tree50ebd60c8ebe38b7a6fad77a94b611f16a197932
parent282616c72d1d08a77ca4fe1186cb708c38408d87 (diff)
downloadgit-e479c5f8f380ea54353b96364f66a4496d213733.tar.gz
docs: clarify that --encoding can produce invalid sequencesjk/pretty-encoding-doc
In the common case that the commit encoding matches the output encoding, we do not touch the buffer at all, which makes things much more efficient. But it might be unclear to a consumer that we will pass through bogus sequences. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/pretty-options.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 8569e29d08..f384673c08 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -33,7 +33,10 @@ people using 80-column terminals.
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.
+ 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.
--notes[=<ref>]::
Show the notes (see linkgit:git-notes[1]) that annotate the