]> git.eshelyaron.com Git - emacs.git/commitdiff
Remove documentation of undefined behavior.
authorXue Fuqiao <xfq.free@gmail.com>
Fri, 16 Aug 2013 00:20:56 +0000 (08:20 +0800)
committerXue Fuqiao <xfq.free@gmail.com>
Fri, 16 Aug 2013 00:20:56 +0000 (08:20 +0800)
* doc/lispref/positions.texi (Character Motion):
* doc/lispref/markers.texi (Moving Markers):
(Creating Markers): Comment out undefined behavior.

* src/marker.c (set_marker): Remove documentation of undefined behavior.

doc/lispref/ChangeLog
doc/lispref/markers.texi
doc/lispref/positions.texi
doc/lispref/text.texi
lisp/follow.el
src/ChangeLog
src/marker.c

index 41e996e697e22261cbef75fc360a9a1e4341a8fe..038705c2f0544444742230e2f947f32660b265cf 100644 (file)
@@ -1,3 +1,9 @@
+2013-08-16  Xue Fuqiao  <xfq.free@gmail.com>
+
+       * positions.texi (Character Motion):
+       * markers.texi (Moving Markers):
+       (Creating Markers): Comment out undefined behavior.
+
 2013-08-15  Xue Fuqiao  <xfq.free@gmail.com>
 
        * markers.texi (The Region): Add/move indexes.
index 712e5f99b63dd10655d88100a702567d101f7017..3863e2f980a5e7955cea9a89f5fa05fe2e170388 100644 (file)
@@ -216,11 +216,14 @@ new marker that points to the same place and the same buffer as does
 The new marker's insertion type is specified by the argument
 @var{insertion-type}.  @xref{Marker Insertion Types}.
 
+@c This behavior used to be documented until 2013/08.
+@ignore
 If passed an integer argument less than 1, @code{copy-marker} returns a
 new marker that points to the beginning of the current buffer.  If
 passed an integer argument greater than the length of the buffer,
 @code{copy-marker} returns a new marker that points to the end of the
 buffer.
+@end ignore
 
 @example
 @group
@@ -351,11 +354,15 @@ This function moves @var{marker} to @var{position}
 in @var{buffer}.  If @var{buffer} is not provided, it defaults to
 the current buffer.
 
+@c This behavior used to be documented until 2013/08.
+@ignore
 If @var{position} is less than 1, @code{set-marker} moves @var{marker}
 to the beginning of the buffer.  If @var{position} is greater than the
 size of the buffer (@pxref{Point}), @code{set-marker} moves marker to
-the end of the buffer.  If @var{position} is @code{nil} or a marker
-that points nowhere, then @var{marker} is set to point nowhere.
+the end of the buffer.
+@end ignore
+If @var{position} is @code{nil} or a marker that points nowhere, then
+@var{marker} is set to point nowhere.
 
 The value returned is @var{marker}.
 
index 8a883061b93ba75f5f98198917d183579b7b3ded..d514cff1a16342e7987a58a2e1ad47f8d6f72c9d 100644 (file)
@@ -146,9 +146,13 @@ that.
 
 @deffn Command goto-char position
 This function sets point in the current buffer to the value
-@var{position}.  If @var{position} is less than 1, it moves point to the
-beginning of the buffer.  If @var{position} is greater than the length
-of the buffer, it moves point to the end.
+@var{position}.
+@c This behavior used to be documented until 2013/08.
+@ignore
+If @var{position} is less than 1, it moves point to the beginning of
+the buffer.  If @var{position} is greater than the length of the
+buffer, it moves point to the end.
+@end ignore
 
 If narrowing is in effect, @var{position} still counts from the
 beginning of the buffer, but point cannot go outside the accessible
index 7cace70ad076d48183e57b933bfafa5861e5f9f8..5346f8dcf58dbb6f865ed69261b8816abdd6b28c 100644 (file)
@@ -240,6 +240,7 @@ Major and minor modes can add functions to
 copied out of the buffer.
 @end defun
 
+@c FIXME: `filter-buffer-substring-function' should be documented.
 @defvar filter-buffer-substring-functions
 This variable is a wrapper hook (@pxref{Running Hooks}), whose members
 should be functions that accept four arguments: @var{fun},
index 3fcdf24f4f20cd7be10341bfac60ebda3b833cca..2c9365b2ba6017bf797ee313a67d90e682b5667a 100644 (file)
@@ -1259,6 +1259,8 @@ non-first windows in Follow mode."
 
        ;; If the region is visible, make it look good when spanning
        ;; multiple windows.
+
+       ;; FIXME: Why not use `use-region-p' here?
        (when (region-active-p)
          (follow-maximize-region
           (selected-window) windows win-start-end)))
index dd4697298ac10883ce29fc705fbd1b456a4cc78a..5dc29ff47aba668f1b18819c26c0e0a04404f130 100644 (file)
@@ -1,3 +1,7 @@
+2013-08-16  Xue Fuqiao  <xfq.free@gmail.com>
+
+       * marker.c (set_marker): Remove documentation of undefined behavior.
+
 2013-08-15  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
        * image.c (imagemagick_compute_animated_image): Animate correctly
index d25e7104b57c656f2fd43f693f6d1b326ed83db9..2f91bdf9727803f7d6a74e1548afa2e3e4b0332f 100644 (file)
@@ -536,11 +536,8 @@ set_marker_internal (Lisp_Object marker, Lisp_Object position,
 DEFUN ("set-marker", Fset_marker, Sset_marker, 2, 3, 0,
        doc: /* Position MARKER before character number POSITION in BUFFER.
 If BUFFER is omitted or nil, it defaults to the current buffer.  If
-POSITION is less than 1, MARKER is moved to the beginning of the
-buffer.  If POSITION is greater than the size of the buffer, marker is
-moved to the end of the buffer.  If POSITION is nil, makes marker
-point nowhere so it no longer slows down editing in any buffer.
-Returns MARKER.  */)
+POSITION is nil, makes marker point nowhere so it no longer slows down
+editing in any buffer.  Returns MARKER.  */)
   (Lisp_Object marker, Lisp_Object position, Lisp_Object buffer)
 {
   return set_marker_internal (marker, position, buffer, 0);