From 39eaef9f8b5aa9481e8d7c636f27b87fe8310060 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sun, 28 Dec 2014 17:43:43 +0200 Subject: [PATCH] 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 79e2dade762491c58aa6396e35bae0ef418bafc6) --- lisp/ChangeLog | 10 ++++ lisp/international/mule.el | 108 ++++++++++++++++++------------------- 2 files changed, 64 insertions(+), 54 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 4b8f8f61c43..bd7959ea348 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,13 @@ +2014-12-28 Eli Zaretskii + + * international/mule.el (define-coding-system): Fix typos in the + doc string. + +2014-12-28 Kenichi Handa + + * international/mule.el (define-coding-system): Improve the doc + string. + 2014-12-27 Fabián Ezequiel Gallina * progmodes/python.el (python-shell-buffer-substring): Handle diff --git a/lisp/international/mule.el b/lisp/international/mule.el index 4f8d50c8c84..c957a77e9ab 100644 --- a/lisp/international/mule.el +++ b/lisp/international/mule.el @@ -599,21 +599,22 @@ opposite of decoding). 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' -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 result of the first step) by a translation table specified -by :decode-translation-table attribute. The optional third step -is to convert the above reslut by a Lisp function specified -by :post-read-conversion attribute. - -The encoding is done by at most 3 steps which are reverse of the -decoding steps. The optional first step converts a character -sequence to another character sequence by a Lisp function -specified by :pre-write-conversion attribute. The optional -second step converts the above result by a translation table -specified by :encode-translation-table attribute.. The third -step converts the abobe result to a byte sequence by one of -Emacs' internal routines specified by :coding-type attribute. +by `:decode-translation-table' attribute. The optional third step +is to convert the above result by a Lisp function specified +by `:post-read-conversion' attribute. + +The encoding is done by at most 3 steps, which are the reverse +of the decoding steps. The optional first step converts a +character sequence to another character sequence by a Lisp +function specified by `:pre-write-conversion' attribute. The +optional second step converts the above result by a translation +table specified by `:encode-translation-table' attribute. The +third step converts the above result to a byte sequence by one +of the Emacs's internal routines specified by the `:coding-type' +attribute. The following attributes have special meanings. Those labeled as \"(required)\" should not be omitted. @@ -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', `raw-text', `undecided'. -If VALUE is `charset', the coding system is for handling a byte -sequence in which each byte or each two to four bytes sequence -represents a character code of a charset specified -by :charset-list attribute. +If VALUE is `charset', the coding system is for handling a +byte sequence in which each byte or every two- to four-byte +sequence represents a character code of a charset specified +by the `:charset-list' attribute. If VALUE is `utf-8', the coding system is for handling Unicode -UTF-8 byte sequence. See also the documentation of the -attribute :bom. +UTF-8 byte sequences. See also the documentation of the +attribute `:bom'. If VALUE is `utf-16', the coding system is for handling Unicode -UTF-16 byte sequence. See also the documentation of the -attributes :bom and :endian. +UTF-16 byte sequences. See also the documentation of the +attributes :bom and `:endian'. -If VALUE is `iso-2022', the coding system is for handling a byte -sequence conforming to ISO/IEC 2022. See also the documentation -of the attributes :charset-list, :flags, and :designation. +If VALUE is `iso-2022', the coding system is for handling byte +sequences conforming to ISO/IEC 2022. See also the documentation +of the attributes `:charset-list', `:flags', and `:designation'. -If VALUE is `emacs-mule', the coding system is for handling a -byte sequence which Emacs 20 and 21 used for internal character -representations. +If VALUE is `emacs-mule', the coding system is for handling +byte sequences which Emacs 20 and 21 used for their internal +representation of characters. -If VALUE is `shift-jis', the coding system is for handling a byte -sequence of Shift_JIS format. See also the -attribute :charset-list. +If VALUE is `shift-jis', the coding system is for handling byte +sequences of Shift_JIS format. See also the attribute `:charset-list'. -If VALUE is `ccl', the coding system uses CCL programs to decodes -and encodes to a byte sequence. The CCL programs must be -specified by the attributes :ccl-decoder and :ccl-encoder. +If VALUE is `ccl', the coding system uses CCL programs to decode +and encode byte sequences. The CCL programs must be +specified by the attributes `:ccl-decoder' and `:ccl-encoder'. -If VALUE is `raw-text', the coding system decodes a byte sequence -as is. +If VALUE is `raw-text', the coding system decodes byte sequences +without any conversions. `:eol-type' 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 -\(i.e. single LF), `dos' means DOS-like EOL \(i.e. sequence of CR LF), -and `mac' means Mac-like EOL \(i.e. single CR). If omitted, Emacs -detects the EOL format automatically when decoding. +\(i.e. a single LF character), `dos' means DOS-like EOL \(i.e. a sequence +of CR followed by LF), and `mac' means Mac-like EOL \(i.e. a single CR). +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. -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 -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 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 to four charsets supported by Shift_JIS encoding scheme. The first charset (one dimension) is for code space 0x00..0x7F, the 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. 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. VALUE must be a function to call after some text is inserted and decoded by the coding system itself and before any functions in `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 -the same, and return the new character count. +unchanged, and should return the new character count. `:pre-write-conversion' @@ -742,7 +742,7 @@ to lower case. `:mime-text-unsuitable' 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' @@ -772,8 +772,8 @@ This attribute is meaningful only when `:coding-type' is `iso-2022'. `:bom' -This attributes specifies whether the coding system uses a `byte order -mark'. VALUE must be nil, t, or cons of coding systems whose +This attributes specifies whether the coding system uses a \"byte order +mark\". VALUE must be nil, t, or a cons cell of coding systems whose `:coding-type' is `utf-16' or `utf-8'. 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. 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'. -If the value is cons, on decoding, check the first two-byte. If they -are 0xFE 0xFF, use the car part coding system of the value. If they -are 0xFF 0xFE, use the cdr part coding system of the value. +If the value is a cons cell, on decoding, check the first two bytes. +If they are 0xFE 0xFF, use the car 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, produce BOM bytes according to the value of `:endian'. @@ -801,14 +801,14 @@ This attribute is meaningful only when `:coding-type' is `utf-16'. `:ccl-decoder' (required if :coding-type is `ccl') VALUE is a CCL program name defined by `define-ccl-program'. The -the CCL program reads a byte sequence and writes a character -sequence as a decoding result. +CCL program reads a byte sequence and writes a character sequence +as a decoding result. `:ccl-encoder' (required if :coding-type is `ccl') VALUE is a CCL program name defined by `define-ccl-program'. The -the CCL program reads a character sequence and writes a byte -sequence as a encoding result. +CCL program reads a character sequence and writes a byte sequence +as an encoding result. `:inhibit-null-byte-detection' -- 2.39.2