diff options
| author | Lars Ingebrigtsen | 2019-12-24 17:11:04 +0100 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2019-12-24 17:11:11 +0100 |
| commit | 0de63092c8ebae3877d97a18fa231c7ca2fbadc0 (patch) | |
| tree | d0eb252cd7a15cf0bed6532631430a9ce2b7013a /src/coding.c | |
| parent | 6184aa003f44363e42762031ca368502021f9e7a (diff) | |
| download | emacs-0de63092c8ebae3877d97a18fa231c7ca2fbadc0.tar.gz emacs-0de63092c8ebae3877d97a18fa231c7ca2fbadc0.zip | |
Clarify base64 requirements and say what {en,de}code_coding_region does
* src/coding.c (Fencode_coding_region): Clarify what this does.
(Fdecode_coding_region): Ditto.
* src/fns.c (Fbase64_decode_region): Clarify that this function
returns bytes, not text (bug#38587).
(Fbase64_encode_region): Clarify that this function takes bytes,
not text.
Diffstat (limited to 'src/coding.c')
| -rw-r--r-- | src/coding.c | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/coding.c b/src/coding.c index d9964908dce..35d6be470c8 100644 --- a/src/coding.c +++ b/src/coding.c | |||
| @@ -9415,6 +9415,13 @@ code_convert_region (Lisp_Object start, Lisp_Object end, | |||
| 9415 | DEFUN ("decode-coding-region", Fdecode_coding_region, Sdecode_coding_region, | 9415 | DEFUN ("decode-coding-region", Fdecode_coding_region, Sdecode_coding_region, |
| 9416 | 3, 4, "r\nzCoding system: ", | 9416 | 3, 4, "r\nzCoding system: ", |
| 9417 | doc: /* Decode the current region from the specified coding system. | 9417 | doc: /* Decode the current region from the specified coding system. |
| 9418 | |||
| 9419 | What's meant by \"decoding\" is transforming bytes into text | ||
| 9420 | (characters). If, for instance, you have a region that contains data | ||
| 9421 | that represents the two bytes #xc2 #xa9, after calling this function | ||
| 9422 | with the utf-8 coding system, the region will contain the single | ||
| 9423 | character ?\\N{COPYRIGHT SIGN}. | ||
| 9424 | |||
| 9418 | When called from a program, takes four arguments: | 9425 | When called from a program, takes four arguments: |
| 9419 | START, END, CODING-SYSTEM, and DESTINATION. | 9426 | START, END, CODING-SYSTEM, and DESTINATION. |
| 9420 | START and END are buffer positions. | 9427 | START and END are buffer positions. |
| @@ -9438,6 +9445,13 @@ not fully specified.) */) | |||
| 9438 | DEFUN ("encode-coding-region", Fencode_coding_region, Sencode_coding_region, | 9445 | DEFUN ("encode-coding-region", Fencode_coding_region, Sencode_coding_region, |
| 9439 | 3, 4, "r\nzCoding system: ", | 9446 | 3, 4, "r\nzCoding system: ", |
| 9440 | doc: /* Encode the current region by specified coding system. | 9447 | doc: /* Encode the current region by specified coding system. |
| 9448 | |||
| 9449 | What's meant by \"encoding\" is transforming textual data (characters) | ||
| 9450 | into bytes. If, for instance, you have a region that contains the | ||
| 9451 | single character ?\\N{COPYRIGHT SIGN}, after calling this function with | ||
| 9452 | the utf-8 coding system, the data in the region will represent the two | ||
| 9453 | bytes #xc2 #xa9. | ||
| 9454 | |||
| 9441 | When called from a program, takes four arguments: | 9455 | When called from a program, takes four arguments: |
| 9442 | START, END, CODING-SYSTEM and DESTINATION. | 9456 | START, END, CODING-SYSTEM and DESTINATION. |
| 9443 | START and END are buffer positions. | 9457 | START and END are buffer positions. |