[COMMIT] Document that START and END are zero-based for insert-file-contents

Aidan Kehoe kehoea at parhasard.net
Tue Oct 2 16:10:16 EDT 2007


APPROVE COMMIT

NOTE: This patch has been committed.

lisp/ChangeLog addition:

2007-10-02  Aidan Kehoe  <kehoea at parhasard.net>

	* code-files.el (insert-file-contents):
	Document that START and END are zero-based, in contrast to buffer
	offsets, and give an example of their use. 


XEmacs Trunk source patch:
Diff command:   cvs -q diff -Nu
Files affected: lisp/code-files.el
===================================================================
RCS

Index: lisp/code-files.el
===================================================================
RCS file: /pack/xemacscvs/XEmacs/xemacs/lisp/code-files.el,v
retrieving revision 1.21
diff -u -u -r1.21 code-files.el
--- lisp/code-files.el	2007/05/12 13:12:28	1.21
+++ lisp/code-files.el	2007/10/02 20:07:49
@@ -357,8 +357,11 @@
 If visiting and the file does not exist, visiting is completed
 before the error is signaled.
 
-The optional third and fourth arguments START and END
-specify what portion of the file to insert.
+The optional third and fourth arguments START and END specify what portion
+of the file to insert, and start at zero, in direct and needless contrast to
+buffer offsets.  That is, values of 0 and 10 for START and END respectively
+will give the first ten octets of a file.
+
 If VISIT is non-nil, START and END must be nil.
 If optional fifth argument REPLACE is non-nil,
 it means replace the current buffer contents (in the accessible portion)

-- 
On the quay of the little Black Sea port, where the rescued pair came once
more into contact with civilization, Dobrinton was bitten by a dog which was
assumed to be mad, though it may only have been indiscriminating. (Saki)




More information about the XEmacs-Patches mailing list