aboutsummaryrefslogtreecommitdiffstats
path: root/src/coding.c
diff options
context:
space:
mode:
authorLars Ingebrigtsen2019-12-24 17:11:04 +0100
committerLars Ingebrigtsen2019-12-24 17:11:11 +0100
commit0de63092c8ebae3877d97a18fa231c7ca2fbadc0 (patch)
treed0eb252cd7a15cf0bed6532631430a9ce2b7013a /src/coding.c
parent6184aa003f44363e42762031ca368502021f9e7a (diff)
downloademacs-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.c14
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,
9415DEFUN ("decode-coding-region", Fdecode_coding_region, Sdecode_coding_region, 9415DEFUN ("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
9419What's meant by \"decoding\" is transforming bytes into text
9420(characters). If, for instance, you have a region that contains data
9421that represents the two bytes #xc2 #xa9, after calling this function
9422with the utf-8 coding system, the region will contain the single
9423character ?\\N{COPYRIGHT SIGN}.
9424
9418When called from a program, takes four arguments: 9425When called from a program, takes four arguments:
9419 START, END, CODING-SYSTEM, and DESTINATION. 9426 START, END, CODING-SYSTEM, and DESTINATION.
9420START and END are buffer positions. 9427START and END are buffer positions.
@@ -9438,6 +9445,13 @@ not fully specified.) */)
9438DEFUN ("encode-coding-region", Fencode_coding_region, Sencode_coding_region, 9445DEFUN ("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
9449What's meant by \"encoding\" is transforming textual data (characters)
9450into bytes. If, for instance, you have a region that contains the
9451single character ?\\N{COPYRIGHT SIGN}, after calling this function with
9452the utf-8 coding system, the data in the region will represent the two
9453bytes #xc2 #xa9.
9454
9441When called from a program, takes four arguments: 9455When called from a program, takes four arguments:
9442 START, END, CODING-SYSTEM and DESTINATION. 9456 START, END, CODING-SYSTEM and DESTINATION.
9443START and END are buffer positions. 9457START and END are buffer positions.