diff options
author | Xue Fuqiao <xfq.free@gmail.com> | 2013-08-16 08:20:56 +0800 |
---|---|---|
committer | Xue Fuqiao <xfq.free@gmail.com> | 2013-08-16 08:20:56 +0800 |
commit | 2bede2ed9605c3f872f564cc94208cebbf13ac8f (patch) | |
tree | c2f1e5714b537ce0b75c1ee22f1ef2cb6c21e173 /doc | |
parent | 0f8a692622e18520c11ae7ae0c3e51b04b410790 (diff) | |
download | emacs-2bede2ed9605c3f872f564cc94208cebbf13ac8f.tar.gz |
Remove documentation of undefined behavior.
* 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.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/ChangeLog | 6 | ||||
-rw-r--r-- | doc/lispref/markers.texi | 11 | ||||
-rw-r--r-- | doc/lispref/positions.texi | 10 | ||||
-rw-r--r-- | doc/lispref/text.texi | 1 |
4 files changed, 23 insertions, 5 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 41e996e697e..038705c2f05 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -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. diff --git a/doc/lispref/markers.texi b/doc/lispref/markers.texi index 712e5f99b63..3863e2f980a 100644 --- a/doc/lispref/markers.texi +++ b/doc/lispref/markers.texi @@ -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}. diff --git a/doc/lispref/positions.texi b/doc/lispref/positions.texi index 8a883061b93..d514cff1a16 100644 --- a/doc/lispref/positions.texi +++ b/doc/lispref/positions.texi @@ -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 diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 7cace70ad07..5346f8dcf58 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -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}, |