[Emacs-diffs] emacs-24 r117548: Doc tweaks re multi-monitor

[Glenn Morris]

------------------------------------------------------------
revno: 117548
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Fri 2014-10-03 20:03:52 -0700
message:
  Doc tweaks re multi-monitor
  
  * doc/lispref/frames.texi (Multiple Terminals): Copyedits re multiple 
monitors.
  
  * lisp/frame.el (frame-monitor-attributes, display-monitor-attributes-list):
  Doc fixes.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/frames.texi        
frames.texi-20091113204419-o5vbwnq5f7feedwu-6180
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/frame.el                  frame.el-20091113204419-o5vbwnq5f7feedwu-275

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-10-03 09:18:49 +0000
+++ b/doc/lispref/ChangeLog     2014-10-04 03:03:52 +0000
@@ -1,3 +1,7 @@
+2014-10-04  Glenn Morris  <address@hidden>
+
+       * frames.texi (Multiple Terminals): Copyedits re multiple monitors.
+
 2014-10-03  Martin Rudalics  <address@hidden>
 
        * frames.texi (Size Parameters, Size and Position): Mention that

=== modified file 'doc/lispref/frames.texi'
--- a/doc/lispref/frames.texi   2014-10-03 15:26:26 +0000
+++ b/doc/lispref/frames.texi   2014-10-04 03:03:52 +0000
@@ -314,57 +314,50 @@
 
 @cindex multi-monitor
   On some ``multi-monitor'' setups, a single X display outputs to more
-than one physical monitor.  @code{display-monitor-attributes-list} and
address@hidden can be used to obtain information
-about each physical monitor on multi-monitor setups.
+than one physical monitor.  You can use the functions
address@hidden and @code{frame-monitor-attributes}
+to obtain information about such setups.
 
 @defun display-monitor-attributes-list &optional display
 This function returns a list of physical monitor attributes on
address@hidden  Each element of the list is an association list,
-representing the attributes of each physical monitor.  The first
-element corresponds to the primary monitor.
-
-Attributes for a physical monitor are:
address@hidden, which defaults to that of the selected frame.
+Each element of the list is an association list, representing the
+attributes of a physical monitor.  The first element corresponds to
+the primary monitor.  The attribute keys and values are:
 
 @table @samp
 @item geometry
-Position and size in pixels in the form of @samp{(X Y WIDTH HEIGHT)}
+Position and size in pixels as @samp{(@var{x} @var{y}
address@hidden @var{height})}.
 
 @item workarea
-Position and size of the workarea in pixels in the form of @samp{(X Y
-WIDTH HEIGHT)}
+Position and size of the work area in pixels as
address@hidden(@var{x} @var{y} @var{width} @var{height})}.
 
 @item mm-size
-Width and height in millimeters in the form of @samp{(WIDTH HEIGHT)}
+Width and height in millimeters as @samp{(@var{width} @var{height})}
 
 @item frames
-List of frames dominated by the physical monitor
+List of frames that this physical monitor dominates (see below).
 
 @item name
-Name of the physical monitor as a string
+Name of the physical monitor as @var{string}.
 @end table
 
-where X, Y, WIDTH, and HEIGHT are integers.  @samp{name} is optional.
-
-A frame is dominated by a physical monitor when either the
-largest area of the frame resides in the monitor, or the monitor
-is the closest to the frame if the frame does not intersect any
-physical monitors.  Every non-tip frame (including invisible one)
-in a graphical display is dominated by exactly one physical
-monitor at a time, though it can span multiple (or no) physical
-monitors.
-
address@hidden defaults to the selected frame's display.
address@hidden, @var{y}, @var{width}, and @var{height} are integers.
address@hidden may not be present.
+
+A frame is @dfn{dominated} by a physical monitor when either the
+largest area of the frame resides in that monitor, or (if the frame
+does not intersect any physical monitors) that monitor is the closest
+to the frame.  Every (non-tooltip) frame (whether visible or not) in a
+graphical display is dominated by exactly one physical monitor at a
+time, though the frame can span multiple (or no) physical monitors.
 @end defun
 
 @defun frame-monitor-attributes &optional frame
 This function returns the attributes of the physical monitor
-dominating @var{frame}, which defaults to the selected frame.
-
-A frame is dominated by a physical monitor when either the
-largest area of the frame resides in the monitor, or the monitor
-is the closest to the frame if the frame does not intersect any
-physical monitors.
+dominating (see above) @var{frame}, which defaults to the selected frame.
 @end defun
 
 @node Frame Parameters

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-10-03 16:06:02 +0000
+++ b/lisp/ChangeLog    2014-10-04 03:03:52 +0000
@@ -1,3 +1,8 @@
+2014-10-04  Glenn Morris  <address@hidden>
+
+       * frame.el (frame-monitor-attributes)
+       (display-monitor-attributes-list): Doc fixes.
+
 2014-10-03  Dmitry Gutov  <address@hidden>
 
        * vc/vc-svn.el (vc-svn-ignore-completion-table): Implement.

=== modified file 'lisp/frame.el'
--- a/lisp/frame.el     2014-10-03 09:18:49 +0000
+++ b/lisp/frame.el     2014-10-04 03:03:52 +0000
@@ -1289,7 +1289,7 @@
 
 (defun frame-monitor-attributes (&optional frame)
   "Return the attributes of the physical monitor dominating FRAME.
-If FRAME is omitted, describe the currently selected frame.
+If FRAME is omitted or nil, describe the currently selected frame.
 
 A frame is dominated by a physical monitor when either the
 largest area of the frame resides in the monitor, or the monitor
@@ -1567,16 +1567,15 @@
 
 (defun display-monitor-attributes-list (&optional display)
   "Return a list of physical monitor attributes on DISPLAY.
-Each element of the list represents the attributes of each
-physical monitor.  The first element corresponds to the primary
-monitor.
-
-Attributes for a physical monitor is represented as an alist of
-attribute keys and values as follows:
-
- geometry -- Position and size in pixels in the form of
-            (X Y WIDTH HEIGHT)
- workarea -- Position and size of the workarea in pixels in the
+If DISPLAY is omitted or nil, it defaults to the selected frame's display.
+Each element of the list represents the attributes of a physical
+monitor.  The first element corresponds to the primary monitor.
+
+The attributes for a physical monitor are represented as an alist
+of attribute keys and values as follows:
+
+ geometry -- Position and size in pixels in the form of (X Y WIDTH HEIGHT)
+ workarea -- Position and size of the work area in pixels in the
             form of (X Y WIDTH HEIGHT)
  mm-size  -- Width and height in millimeters in the form of
             (WIDTH HEIGHT)
@@ -1589,11 +1588,10 @@
 A frame is dominated by a physical monitor when either the
 largest area of the frame resides in the monitor, or the monitor
 is the closest to the frame if the frame does not intersect any
-physical monitors.  Every non-tip frame (including invisible one)
+physical monitors.  Every (non-tooltip) frame (including invisible ones)
 in a graphical display is dominated by exactly one physical
 monitor at a time, though it can span multiple (or no) physical
-monitors.
-If DISPLAY is omitted or nil, it defaults to the selected frame's display."
+monitors."
   (let ((frame-type (framep-on-display display)))
     (cond
      ((eq frame-type 'x)