aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorPhilipp Stephani2016-08-19 21:23:24 +0200
committerPhilipp Stephani2016-08-20 18:25:05 +0200
commit9b99772cf4b24443e1c096bb1e847da4cf502543 (patch)
tree32702965737695ae1a523f4dac9999472ca96524 /src
parent37d4723f73998ecbf30e9f655026422b0e2017a7 (diff)
downloademacs-9b99772cf4b24443e1c096bb1e847da4cf502543.tar.gz
emacs-9b99772cf4b24443e1c096bb1e847da4cf502543.zip
Some assorted documentation clarifications
* src/fileio.c (Fwrite_region): Clarify that END is ignored if START is nil. * src/editfns.c (Fbuffer_size): Add short discussion about narrowing. * src/callproc.c (Fcall_process_region): Discuss behavior when START and END are not buffer positions.
Diffstat (limited to 'src')
-rw-r--r--src/callproc.c7
-rw-r--r--src/editfns.c9
-rw-r--r--src/fileio.c3
3 files changed, 17 insertions, 2 deletions
diff --git a/src/callproc.c b/src/callproc.c
index 2fb5b1d5194..76b5caa4465 100644
--- a/src/callproc.c
+++ b/src/callproc.c
@@ -1005,6 +1005,13 @@ create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
1005DEFUN ("call-process-region", Fcall_process_region, Scall_process_region, 1005DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1006 3, MANY, 0, 1006 3, MANY, 0,
1007 doc: /* Send text from START to END to a synchronous process running PROGRAM. 1007 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1008
1009START and END are normally buffer positions specifying the part of the
1010buffer to send to the process.
1011If START is nil, that means to use the entire buffer contents; END is
1012ignored.
1013If START is a string, then send that string to the process
1014instead of any buffer contents; END is ignored.
1008The remaining arguments are optional. 1015The remaining arguments are optional.
1009Delete the text if fourth arg DELETE is non-nil. 1016Delete the text if fourth arg DELETE is non-nil.
1010 1017
diff --git a/src/editfns.c b/src/editfns.c
index 32c8bec6db2..e1c85166545 100644
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -1029,7 +1029,14 @@ usage: (save-current-buffer &rest BODY) */)
1029 1029
1030DEFUN ("buffer-size", Fbuffer_size, Sbuffer_size, 0, 1, 0, 1030DEFUN ("buffer-size", Fbuffer_size, Sbuffer_size, 0, 1, 0,
1031 doc: /* Return the number of characters in the current buffer. 1031 doc: /* Return the number of characters in the current buffer.
1032If BUFFER, return the number of characters in that buffer instead. */) 1032If BUFFER is not nil, return the number of characters in that buffer
1033instead.
1034
1035This does not take narrowing into account; to count the number of
1036characters in the accessible portion of the current buffer, use
1037`(- (point-max) (point-min))', and to count the number of characters
1038in some other BUFFER, use
1039`(with-current-buffer BUFFER (- (point-max) (point-min)))'. */)
1033 (Lisp_Object buffer) 1040 (Lisp_Object buffer)
1034{ 1041{
1035 if (NILP (buffer)) 1042 if (NILP (buffer))
diff --git a/src/fileio.c b/src/fileio.c
index 3005ca320e7..c3b2be7c5f7 100644
--- a/src/fileio.c
+++ b/src/fileio.c
@@ -4644,7 +4644,8 @@ DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4644When called from a program, requires three arguments: 4644When called from a program, requires three arguments:
4645START, END and FILENAME. START and END are normally buffer positions 4645START, END and FILENAME. START and END are normally buffer positions
4646specifying the part of the buffer to write. 4646specifying the part of the buffer to write.
4647If START is nil, that means to use the entire buffer contents. 4647If START is nil, that means to use the entire buffer contents; END is
4648ignored.
4648If START is a string, then output that string to the file 4649If START is a string, then output that string to the file
4649instead of any buffer contents; END is ignored. 4650instead of any buffer contents; END is ignored.
4650 4651