[Emacs-diffs] emacs-24 r117212: Doc updates re window-setup-hook

[Glenn Morris]

------------------------------------------------------------
revno: 117212
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Fri 2014-06-06 00:19:23 -0700
message:
  Doc updates re window-setup-hook
  
  * lisp/startup.el (window-setup-hook): Doc fix.
  
  * doc/lispref/display.texi (Window Systems): Remove window-setup-hook.
  
  * doc/lispref/os.texi (Startup Summary, Init File):
  Improve description of window-setup-hook.
  (Terminal-Specific): Update window-setup-hook cross-reference.
  
  * doc/lispref/hooks.texi (Standard Hooks):
  Update window-setup-hook cross-reference.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/display.texi       
display.texi-20091113204419-o5vbwnq5f7feedwu-6172
  doc/lispref/hooks.texi         hooks.texi-20091113204419-o5vbwnq5f7feedwu-6186
  doc/lispref/os.texi            os.texi-20091113204419-o5vbwnq5f7feedwu-6205
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/startup.el                startup.el-20091113204419-o5vbwnq5f7feedwu-260

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-06-06 06:45:16 +0000
+++ b/doc/lispref/ChangeLog     2014-06-06 07:19:23 +0000
@@ -1,5 +1,11 @@
 2014-06-06  Glenn Morris  <address@hidden>
 
+       * display.texi (Window Systems): Remove window-setup-hook.
+       * os.texi (Startup Summary, Init File):
+       Improve description of window-setup-hook.
+       (Terminal-Specific): Update window-setup-hook cross-reference.
+       * hooks.texi (Standard Hooks): Update window-setup-hook cross-reference.
+
        * display.texi (Overlay Properties): Update re priority.  (Bug#17234)
 
 2014-06-05  Glenn Morris  <address@hidden>

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2014-06-06 06:45:16 +0000
+++ b/doc/lispref/display.texi  2014-06-06 07:19:23 +0000
@@ -6519,18 +6519,6 @@
 @code{display-graphic-p} or any of the other @code{display-*-p}
 predicates described in @ref{Display Feature Testing}.
 
address@hidden window-setup-hook
-This variable is a normal hook which Emacs runs after handling the
-initialization files.  Emacs runs this hook after it has completed
-loading your init file, the default initialization file (if
-any), and the terminal-specific Lisp code, and running the hook
address@hidden
-
-This hook is used for internal purposes: setting up communication with
-the window system, and creating the initial window.  Users should not
-interfere with it.
address@hidden defvar
-
 @node Bidirectional Display
 @section Bidirectional Display
 @cindex bidirectional display

=== modified file 'doc/lispref/hooks.texi'
--- a/doc/lispref/hooks.texi    2014-05-27 01:53:45 +0000
+++ b/doc/lispref/hooks.texi    2014-06-06 07:19:23 +0000
@@ -55,6 +55,7 @@
 @item after-init-hook
 @itemx before-init-hook
 @itemx emacs-startup-hook
address@hidden window-setup-hook
 @xref{Init File}.
 
 @item after-insert-file-functions
@@ -220,9 +221,6 @@
 @itemx window-size-change-functions
 @xref{Window Hooks}.
 
address@hidden window-setup-hook
address@hidden Systems}.
-
 @item window-text-change-functions
 @vindex window-text-change-functions
 Functions to call in redisplay when text in the window might change.

=== modified file 'doc/lispref/os.texi'
--- a/doc/lispref/os.texi       2014-04-05 18:33:55 +0000
+++ b/doc/lispref/os.texi       2014-06-06 07:19:23 +0000
@@ -218,7 +218,9 @@
 specify.
 
 @item
-It runs @code{window-setup-hook}.  @xref{Window Systems}.
+It runs @code{window-setup-hook}.  The only difference between this
+hook and @code{emacs-startup-hook} is that this one runs after the
+previously mentioned modifications to the frame parameters.
 
 @item
 @cindex startup screen
@@ -411,6 +413,12 @@
 arguments.  In batch mode, Emacs does not run this hook.
 @end defvar
 
address@hidden window-setup-hook
+This normal hook is very similar to @code{emacs-startup-hook}.
+The only difference is that it runs slightly later, after setting
+of the frame parameters.  @xref{Startup Summary, window-setup-hook}.
address@hidden defvar
+
 @defvar user-init-file
 This variable holds the absolute file name of the user's init file.  If the
 actual init file loaded is a compiled file, such as @file{.emacs.elc},
@@ -487,7 +495,7 @@
 terminal-specific Lisp file, so you can use it to adjust the
 definitions made by that file.
 
-For a related feature, @pxref{Window Systems, window-setup-hook}.
+For a related feature, @pxref{Init File, window-setup-hook}.
 @end defvar
 
 @node Command-Line Arguments

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-06-05 06:15:44 +0000
+++ b/lisp/ChangeLog    2014-06-06 07:19:23 +0000
@@ -1,3 +1,7 @@
+2014-06-06  Glenn Morris  <address@hidden>
+
+       * startup.el (window-setup-hook): Doc fix.
+
 2014-06-05  Glenn Morris  <address@hidden>
 
        * emacs-lisp/package.el (package-check-signature)

=== modified file 'lisp/startup.el'
--- a/lisp/startup.el   2014-03-18 00:42:37 +0000
+++ b/lisp/startup.el   2014-06-06 07:19:23 +0000
@@ -302,9 +302,12 @@
 environment variable TERM.")
 
 (defvar window-setup-hook nil
-  "Normal hook run to initialize window system display.
-Emacs runs this hook after processing the command line arguments and loading
-the user's init file.")
+  "Normal hook run after loading init files and handling the command line.
+This is very similar to `emacs-startup-hook'.  The only difference
+is that this hook runs after frame parameters have been set up in
+response to any settings from your init file.  Unless this matters
+to you, use `emacs-startup-hook' instead.  (The name of this hook
+is due to historical reasons, and does not reflect its purpose very well.)")
 
 (defcustom initial-major-mode 'lisp-interaction-mode
   "Major mode command symbol to use for the initial `*scratch*' buffer."