]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: use "character encoding" to refer to commit-object encoding
authorJeff King <peff@peff.net>
Fri, 27 Aug 2021 18:32:06 +0000 (14:32 -0400)
committerJunio C Hamano <gitster@pobox.com>
Fri, 27 Aug 2021 19:45:45 +0000 (12:45 -0700)
The word "encoding" can mean a lot of things (e.g., base64 or
quoted-printable encoding in emails, HTML entities, URL encoding, and so
on). The documentation for i18n.commitEncoding and i18n.logOutputEncoding
uses the phrase "character encoding" to make this more clear.

Let's use that phrase in other places to make it clear what kind of
encoding we are talking about. This patch covers the gui.encoding
option, as well as the --encoding option for git-log, etc (in this
latter case, I word-smithed the sentence a little at the same time).
That, coupled with the mention of iconv in the --encoding description,
should make this more clear.

The other spot I looked at is the working-tree-encoding section of
gitattributes(5). But it gives specific examples of encodings that I
think make the meaning pretty clear already.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/gui.txt
Documentation/pretty-options.txt

index d30831a130800ac12a1fd8296ea6cff530d518b3..0c087fd8c9313e5e68dcd7cd7a91b6900936febc 100644 (file)
@@ -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]).
index 42b227bc4011f391e27ac2f921b66c993ede3eed..b3af8506086a83216abc5e5791dfe6c36eaf978c 100644 (file)
@@ -33,7 +33,7 @@ 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