Document nil args of compare-buffer-substrings

* editfns.c (Fcompare_buffer_substrings): Document behavior when
the arguments are nil.

diff --git a/src/editfns.c b/src/editfns.c
index 51b87de88219b442382118f93b5d97b0e793382c..4e90dad568f014048fe0ad5f855ba86197b6205d 100644 (file)
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -2892,6 +2892,10 @@ Return -N if first string is less after N-1 chars, +N if first string is
 greater after N-1 chars, or 0 if strings match.
 The first substring is in BUFFER1 from START1 to END1 and the second
 is in BUFFER2 from START2 to END2.
+All arguments may be nil.  If BUFFER1 or BUFFER2 is nil, the current
+buffer is used.  If START1 or START2 is nil, the value of `point-min'
+in the respective buffers is used.  If END1 or END2 is nil, the value
+of `point-max' in the respective buffers is used.
 The value of `case-fold-search' in the current buffer
 determines whether case is significant or ignored.  */)
   (Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2)