Documentation of write-contents-functions

Documentation of write-contents-functions

[Lars Hansen]

[-- Attachment #1: Type: text/plain, Size: 138 bytes --]

To me the description in files.texi of write-contents-functions does not 
make much sense.
I suggest the chances attached.
Do you agree?


[-- Attachment #2: files.texi.diff --]
[-- Type: text/plain, Size: 1402 bytes --]

*** files.texi.~1.66.~	Sun May 30 08:41:47 2004
--- files.texi	Tue Jun 22 21:04:00 2004
***************
*** 416,426 ****
  @c Emacs 19 feature
  @defvar write-contents-functions
  This works just like @code{write-file-functions}, but it is intended for
! hooks that pertain to the contents of the file, as opposed to hooks that
! pertain to where the file came from.  Such hooks are usually set up by
  major modes, as buffer-local bindings for this variable.  If any of the
! functions in this hook returns non-@code{nil}, @code{write-file-functions}
! is not run.
  
  This variable automatically becomes buffer-local whenever it is set;
  switching to a new major mode always resets this variable, but
--- 416,427 ----
  @c Emacs 19 feature
  @defvar write-contents-functions
  This works just like @code{write-file-functions}, but it is intended for
! hooks that pertain to the contents of the buffer, as opposed to hooks that
! pertain to the file the buffers visits.  Such hooks are usually set up by
  major modes, as buffer-local bindings for this variable.  If any of the
! functions in this hook returns non-@code{nil}, the file is considered
! already written and the rest are not called and neither are the functions
! in @code{write-file-functions}.
  
  This variable automatically becomes buffer-local whenever it is set;
  switching to a new major mode always resets this variable, but

[-- Attachment #3: files.el.diff --]
[-- Type: text/plain, Size: 893 bytes --]

*** files.el.~1.705.~	Thu Jun 17 08:26:50 2004
--- files.el	Tue Jun 22 21:02:01 2004
***************
*** 393,399 ****
  (defvar write-contents-functions nil
    "List of functions to be called before writing out a buffer to a file.
  If one of them returns non-nil, the file is considered already written
! and the rest are not called.
  
  This variable is meant to be used for hooks that pertain to the
  buffer's contents, not to the particular visited file; thus,
--- 393,400 ----
  (defvar write-contents-functions nil
    "List of functions to be called before writing out a buffer to a file.
  If one of them returns non-nil, the file is considered already written
! and the rest are not called and neither are the functions in
! `write-file-functions'.
  
  This variable is meant to be used for hooks that pertain to the
  buffer's contents, not to the particular visited file; thus,

[-- Attachment #4: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel

Re: Documentation of write-contents-functions

[Luc Teirlinck]

Lars Hansen wrote:
   
   To me the description in files.texi of write-contents-functions does not 
   make much sense.
   I suggest the chances attached.
   Do you agree?

These changes are OK with me.

Sincerely,

Luc.