[Emacs-diffs] /srv/bzr/emacs/trunk r107611: Doc fixes for view-mode and special major-modes

[Glenn Morris]

------------------------------------------------------------
revno: 107611
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2012-03-15 21:40:20 -0400
message:
  Doc fixes for view-mode and special major-modes
  
  Ref: http://debbugs.gnu.org/10650
  
  * doc/lispref/modes.texi (Major Mode Conventions):
  Mention the strange (IMO) relationship between View mode and special modes.
  
  * lisp/view.el (view-buffer, view-buffer-other-window)
  (view-buffer-other-frame): Doc fixes re special mode-class.
modified:
  doc/lispref/ChangeLog
  doc/lispref/modes.texi
  lisp/ChangeLog
  lisp/view.el

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-03-11 16:27:36 +0000
+++ b/doc/lispref/ChangeLog     2012-03-16 01:40:20 +0000
@@ -1,3 +1,8 @@
+2012-03-16  Glenn Morris  <address@hidden>
+
+       * modes.texi (Major Mode Conventions): Mention the strange
+       relationship between View mode and special modes.  (Bug#10650)
+
 2012-03-11  Chong Yidong  <address@hidden>
 
        * windows.texi (Window Configurations): save-window-excursion is

=== modified file 'doc/lispref/modes.texi'
--- a/doc/lispref/modes.texi    2012-03-02 02:52:40 +0000
+++ b/doc/lispref/modes.texi    2012-03-16 01:40:20 +0000
@@ -525,6 +525,10 @@
 @code{special} modes, Fundamental mode is used instead.  Modes such as
 Dired, Rmail, and Buffer List use this feature.
 
+The function @code{view-buffer} does not enable View mode in buffers
+whose mode-class is special, because such modes usually provide their
+own View-like bindings.
+
 The @code{define-derived-mode} macro automatically marks the derived
 mode as special if the parent mode is special.  Special mode is a
 convenient parent for such modes to inherit from; @xref{Basic Major

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-03-16 01:27:23 +0000
+++ b/lisp/ChangeLog    2012-03-16 01:40:20 +0000
@@ -1,5 +1,8 @@
 2012-03-16  Glenn Morris  <address@hidden>
 
+       * view.el (view-buffer, view-buffer-other-window)
+       (view-buffer-other-frame): Doc fixes re special mode-class.
+
        * subr.el (eval-after-load): If named feature is provided not from
        a file, run after-load forms.  (Bug#10946)
 

=== modified file 'lisp/view.el'
--- a/lisp/view.el      2012-02-01 08:31:29 +0000
+++ b/lisp/view.el      2012-03-16 01:40:20 +0000
@@ -309,7 +309,11 @@
 Do not set EXIT-ACTION to `kill-buffer' when BUFFER visits a
 file: Users may suspend viewing in order to modify the buffer.
 Exiting View mode will then discard the user's edits.  Setting
-EXIT-ACTION to `kill-buffer-if-not-modified' avoids this."
+EXIT-ACTION to `kill-buffer-if-not-modified' avoids this.
+
+This function does not enable View mode if the buffer's major-mode
+has a `special' mode-class, because such modes usually have their
+own View-like bindings."
   (interactive "bView buffer: ")
   (switch-to-buffer buffer)
   (if (eq (get major-mode 'mode-class) 'special)
@@ -331,7 +335,11 @@
 
 Optional argument EXIT-ACTION is either nil or a function with buffer as
 argument.  This function is called when finished viewing buffer.  Use
-this argument instead of explicitly setting `view-exit-action'."
+this argument instead of explicitly setting `view-exit-action'.
+
+This function does not enable View mode if the buffer's major-mode
+has a `special' mode-class, because such modes usually have their
+own View-like bindings."
   (interactive "bIn other window view buffer:\nP")
   (let ((pop-up-windows t))
     (pop-to-buffer buffer t))
@@ -354,7 +362,11 @@
 
 Optional argument EXIT-ACTION is either nil or a function with buffer as
 argument.  This function is called when finished viewing buffer.  Use
-this argument instead of explicitly setting `view-exit-action'."
+this argument instead of explicitly setting `view-exit-action'.
+
+This function does not enable View mode if the buffer's major-mode
+has a `special' mode-class, because such modes usually have their
+own View-like bindings."
   (interactive "bView buffer in other frame: \nP")
   (let ((pop-up-frames t))
     (pop-to-buffer buffer t))