Commit 39eaef9f authored by Eli Zaretskii's avatar Eli Zaretskii

lisp/international/mule.el (define-coding-system): Fix typos in the doc string.

Add missing ChangeLog entry for the previous commit.

Backported from trunk; do not merge back.

(cherry picked from commit 79e2dade)
parent df932d85
2014-12-28 Eli Zaretskii <eliz@gnu.org>
* international/mule.el (define-coding-system): Fix typos in the
doc string.
2014-12-28 Kenichi Handa <handa@gnu.org>
* international/mule.el (define-coding-system): Improve the doc
string.
2014-12-27 Fabián Ezequiel Gallina <fgallina@gnu.org> 2014-12-27 Fabián Ezequiel Gallina <fgallina@gnu.org>
* progmodes/python.el (python-shell-buffer-substring): Handle * progmodes/python.el (python-shell-buffer-substring): Handle
......
...@@ -599,21 +599,22 @@ opposite of decoding). ...@@ -599,21 +599,22 @@ opposite of decoding).
The decoding is done by at most 3 steps; the first is to convert The decoding is done by at most 3 steps; the first is to convert
a byte sequence to a character sequence by one of Emacs' a byte sequence to a character sequence by one of Emacs'
internal routines specified by :coding-type attribute. The internal routines specified by `:coding-type' attribute. The
optional second step is to convert the character sequence (the optional second step is to convert the character sequence (the
result of the first step) by a translation table specified result of the first step) by a translation table specified
by :decode-translation-table attribute. The optional third step by `:decode-translation-table' attribute. The optional third step
is to convert the above reslut by a Lisp function specified is to convert the above result by a Lisp function specified
by :post-read-conversion attribute. by `:post-read-conversion' attribute.
The encoding is done by at most 3 steps which are reverse of the The encoding is done by at most 3 steps, which are the reverse
decoding steps. The optional first step converts a character of the decoding steps. The optional first step converts a
sequence to another character sequence by a Lisp function character sequence to another character sequence by a Lisp
specified by :pre-write-conversion attribute. The optional function specified by `:pre-write-conversion' attribute. The
second step converts the above result by a translation table optional second step converts the above result by a translation
specified by :encode-translation-table attribute.. The third table specified by `:encode-translation-table' attribute. The
step converts the abobe result to a byte sequence by one of third step converts the above result to a byte sequence by one
Emacs' internal routines specified by :coding-type attribute. of the Emacs's internal routines specified by the `:coding-type'
attribute.
The following attributes have special meanings. Those labeled as The following attributes have special meanings. Those labeled as
\"(required)\" should not be omitted. \"(required)\" should not be omitted.
...@@ -629,53 +630,52 @@ decodes and encodes to. It must be one of `charset', `utf-8', ...@@ -629,53 +630,52 @@ decodes and encodes to. It must be one of `charset', `utf-8',
`utf-16', `iso-2022', `emacs-mule', `shift-jis', `ccl', `utf-16', `iso-2022', `emacs-mule', `shift-jis', `ccl',
`raw-text', `undecided'. `raw-text', `undecided'.
If VALUE is `charset', the coding system is for handling a byte If VALUE is `charset', the coding system is for handling a
sequence in which each byte or each two to four bytes sequence byte sequence in which each byte or every two- to four-byte
represents a character code of a charset specified sequence represents a character code of a charset specified
by :charset-list attribute. by the `:charset-list' attribute.
If VALUE is `utf-8', the coding system is for handling Unicode If VALUE is `utf-8', the coding system is for handling Unicode
UTF-8 byte sequence. See also the documentation of the UTF-8 byte sequences. See also the documentation of the
attribute :bom. attribute `:bom'.
If VALUE is `utf-16', the coding system is for handling Unicode If VALUE is `utf-16', the coding system is for handling Unicode
UTF-16 byte sequence. See also the documentation of the UTF-16 byte sequences. See also the documentation of the
attributes :bom and :endian. attributes :bom and `:endian'.
If VALUE is `iso-2022', the coding system is for handling a byte If VALUE is `iso-2022', the coding system is for handling byte
sequence conforming to ISO/IEC 2022. See also the documentation sequences conforming to ISO/IEC 2022. See also the documentation
of the attributes :charset-list, :flags, and :designation. of the attributes `:charset-list', `:flags', and `:designation'.
If VALUE is `emacs-mule', the coding system is for handling a If VALUE is `emacs-mule', the coding system is for handling
byte sequence which Emacs 20 and 21 used for internal character byte sequences which Emacs 20 and 21 used for their internal
representations. representation of characters.
If VALUE is `shift-jis', the coding system is for handling a byte If VALUE is `shift-jis', the coding system is for handling byte
sequence of Shift_JIS format. See also the sequences of Shift_JIS format. See also the attribute `:charset-list'.
attribute :charset-list.
If VALUE is `ccl', the coding system uses CCL programs to decodes If VALUE is `ccl', the coding system uses CCL programs to decode
and encodes to a byte sequence. The CCL programs must be and encode byte sequences. The CCL programs must be
specified by the attributes :ccl-decoder and :ccl-encoder. specified by the attributes `:ccl-decoder' and `:ccl-encoder'.
If VALUE is `raw-text', the coding system decodes a byte sequence If VALUE is `raw-text', the coding system decodes byte sequences
as is. without any conversions.
`:eol-type' `:eol-type'
VALUE is the EOL (end-of-line) format of the coding system. It must be VALUE is the EOL (end-of-line) format of the coding system. It must be
one of `unix', `dos', `mac'. The symbol `unix' means Unix-like EOL one of `unix', `dos', `mac'. The symbol `unix' means Unix-like EOL
\(i.e. single LF), `dos' means DOS-like EOL \(i.e. sequence of CR LF), \(i.e. a single LF character), `dos' means DOS-like EOL \(i.e. a sequence
and `mac' means Mac-like EOL \(i.e. single CR). If omitted, Emacs of CR followed by LF), and `mac' means Mac-like EOL \(i.e. a single CR).
detects the EOL format automatically when decoding. If omitted, Emacs detects the EOL format automatically when decoding.
`:charset-list' (required if :coding-type is `charset' or `shift-jis') `:charset-list' (required if `:coding-type' is `charset' or `shift-jis')
VALUE must be a list of charsets supported by the coding system. VALUE must be a list of charsets supported by the coding system.
If `coding-type:' is `charset', on decoding and encoding by the If `coding-type:' is `charset', then on decoding and encoding by the
coding system, if a character belongs to multiple charsets in the coding system, if a character belongs to multiple charsets in the
list, a charset that comes earlier in the list is selected. list, a charset that comes first in the list is selected.
If `:coding-type' is `iso-2022', VALUE may be `iso-2022', which If `:coding-type' is `iso-2022', VALUE may be `iso-2022', which
indicates that the coding system supports all ISO-2022 based indicates that the coding system supports all ISO-2022 based
...@@ -685,7 +685,7 @@ If `:coding-type' is `shift-jis', VALUE must be a list of three ...@@ -685,7 +685,7 @@ If `:coding-type' is `shift-jis', VALUE must be a list of three
to four charsets supported by Shift_JIS encoding scheme. The to four charsets supported by Shift_JIS encoding scheme. The
first charset (one dimension) is for code space 0x00..0x7F, the first charset (one dimension) is for code space 0x00..0x7F, the
second (one dimension) for 0xA1..0xDF, the third (two dimension) second (one dimension) for 0xA1..0xDF, the third (two dimension)
for 0x8140..0xEFFC, the optional fourth (thw dimension) for for 0x8140..0xEFFC, the optional fourth (three dimension) for
0xF040..0xFCFC. 0xF040..0xFCFC.
If `:coding-type' is `emacs-mule', VALUE may be `emacs-mule', If `:coding-type' is `emacs-mule', VALUE may be `emacs-mule',
...@@ -711,9 +711,9 @@ VALUE must be a translation table to use on encoding. ...@@ -711,9 +711,9 @@ VALUE must be a translation table to use on encoding.
VALUE must be a function to call after some text is inserted and VALUE must be a function to call after some text is inserted and
decoded by the coding system itself and before any functions in decoded by the coding system itself and before any functions in
`after-insert-functions' are called. This function is passed one `after-insert-functions' are called. This function is passed one
argument; the number of characters in the text to convert, with argument: the number of characters in the text to convert, with
point at the start of the text. The function should leave point point at the start of the text. The function should leave point
the same, and return the new character count. unchanged, and should return the new character count.
`:pre-write-conversion' `:pre-write-conversion'
...@@ -742,7 +742,7 @@ to lower case. ...@@ -742,7 +742,7 @@ to lower case.
`:mime-text-unsuitable' `:mime-text-unsuitable'
VALUE non-nil means the `:mime-charset' property names a charset which VALUE non-nil means the `:mime-charset' property names a charset which
is unsuitable for the top-level media type \"text\". is unsuitable for the top-level media of type \"text\".
`:flags' `:flags'
...@@ -772,8 +772,8 @@ This attribute is meaningful only when `:coding-type' is `iso-2022'. ...@@ -772,8 +772,8 @@ This attribute is meaningful only when `:coding-type' is `iso-2022'.
`:bom' `:bom'
This attributes specifies whether the coding system uses a `byte order This attributes specifies whether the coding system uses a \"byte order
mark'. VALUE must be nil, t, or cons of coding systems whose mark\". VALUE must be nil, t, or a cons cell of coding systems whose
`:coding-type' is `utf-16' or `utf-8'. `:coding-type' is `utf-16' or `utf-8'.
If the value is nil, on decoding, don't treat the first two-byte as If the value is nil, on decoding, don't treat the first two-byte as
...@@ -782,9 +782,9 @@ BOM, and on encoding, don't produce BOM bytes. ...@@ -782,9 +782,9 @@ BOM, and on encoding, don't produce BOM bytes.
If the value is t, on decoding, skip the first two-byte as BOM, and on If the value is t, on decoding, skip the first two-byte as BOM, and on
encoding, produce BOM bytes according to the value of `:endian'. encoding, produce BOM bytes according to the value of `:endian'.
If the value is cons, on decoding, check the first two-byte. If they If the value is a cons cell, on decoding, check the first two bytes.
are 0xFE 0xFF, use the car part coding system of the value. If they If they are 0xFE 0xFF, use the car part coding system of the value.
are 0xFF 0xFE, use the cdr part coding system of the value. If they are 0xFF 0xFE, use the cdr part coding system of the value.
Otherwise, treat them as bytes for a normal character. On encoding, Otherwise, treat them as bytes for a normal character. On encoding,
produce BOM bytes according to the value of `:endian'. produce BOM bytes according to the value of `:endian'.
...@@ -801,14 +801,14 @@ This attribute is meaningful only when `:coding-type' is `utf-16'. ...@@ -801,14 +801,14 @@ This attribute is meaningful only when `:coding-type' is `utf-16'.
`:ccl-decoder' (required if :coding-type is `ccl') `:ccl-decoder' (required if :coding-type is `ccl')
VALUE is a CCL program name defined by `define-ccl-program'. The VALUE is a CCL program name defined by `define-ccl-program'. The
the CCL program reads a byte sequence and writes a character CCL program reads a byte sequence and writes a character sequence
sequence as a decoding result. as a decoding result.
`:ccl-encoder' (required if :coding-type is `ccl') `:ccl-encoder' (required if :coding-type is `ccl')
VALUE is a CCL program name defined by `define-ccl-program'. The VALUE is a CCL program name defined by `define-ccl-program'. The
the CCL program reads a character sequence and writes a byte CCL program reads a character sequence and writes a byte sequence
sequence as a encoding result. as an encoding result.
`:inhibit-null-byte-detection' `:inhibit-null-byte-detection'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment