Skip to content

Commit

Permalink
docs: clarify that --encoding can produce invalid sequences
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Jeff King authored and Junio C Hamano committed Jun 17, 2015
1 parent 282616c commit e479c5f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Documentation/pretty-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e479c5f

Please sign in to comment.