Is buffer-flush-undo obsolete?

Is buffer-flush-undo obsolete?

[Lute Kamstra]

The docstring and the Elisp Manual contradict.

,----[ C-h f buffer-flush-undo RET ]
| buffer-flush-undo is an alias for `buffer-disable-undo' in `subr'.
| (buffer-flush-undo &optional BUFFER)
| 
| This function is obsolete since before 19.15;
| use `buffer-disable-undo' instead.
| 
| Make BUFFER stop keeping undo information.
| No argument or nil as argument means do this for the current buffer.
`----

,----[ Elisp Manual; Maintaining Undo Lists ]
|  -- Command: buffer-disable-undo &optional buffer-or-name
|  -- Command: buffer-flush-undo &optional buffer-or-name
|      This function discards the undo list of BUFFER-OR-NAME, and
|      disables further recording of undo information.  As a result, it
|      is no longer possible to undo either previous changes or any
|      subsequent changes.  If the undo list of BUFFER-OR-NAME is already
|      disabled, this function has no effect.
| 
|      This function returns `nil'.
| 
|      The name `buffer-flush-undo' is not considered obsolete, but the
|      preferred name is `buffer-disable-undo'.
`----


Lute.

Re: Is buffer-flush-undo obsolete?

[Richard Stallman]

Yes it is.  Thanks.

Re: Is buffer-flush-undo obsolete?

[Lute Kamstra]

Richard Stallman <rms@gnu.org> writes:

> Yes it is.  Thanks.

Shall I just remove the reference to buffer-flush-undo, like this?


*** lispref/text.texi	3 Feb 2005 07:09:17 -0000	1.91
--- lispref/text.texi	3 Feb 2005 19:58:49 -0000
***************
*** 1,7 ****
  @c -*-texinfo-*-
  @c This is part of the GNU Emacs Lisp Reference Manual.
  @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999,
! @c 2000, 2001, 2004
  @c   Free Software Foundation, Inc.
  @c See the file elisp.texi for copying conditions.
  @setfilename ../info/text
--- 1,7 ----
  @c -*-texinfo-*-
  @c This is part of the GNU Emacs Lisp Reference Manual.
  @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999,
! @c 2000, 2001, 2004, 2005
  @c   Free Software Foundation, Inc.
  @c See the file elisp.texi for copying conditions.
  @setfilename ../info/text
***************
*** 1305,1311 ****
  @end deffn
  
  @deffn Command buffer-disable-undo &optional buffer-or-name
- @deffnx Command buffer-flush-undo &optional buffer-or-name
  @cindex disable undo
  This function discards the undo list of @var{buffer-or-name}, and disables
  further recording of undo information.  As a result, it is no longer
--- 1305,1310 ----
***************
*** 1314,1322 ****
  has no effect.
  
  This function returns @code{nil}.
- 
- The name @code{buffer-flush-undo} is not considered obsolete, but the
- preferred name is @code{buffer-disable-undo}.
  @end deffn
  
    As editing continues, undo lists get longer and longer.  To prevent
--- 1313,1318 ----

Re: Is buffer-flush-undo obsolete?

[Richard Stallman]

    Shall I just remove the reference to buffer-flush-undo, like this?

Yes.