[Emacs-diffs] trunk r113755: lisp/frameset.el: Doc fixes.

[Juanma Barranquero]

------------------------------------------------------------
revno: 113755
revision-id: address@hidden
parent: address@hidden
committer: Juanma Barranquero <address@hidden>
branch nick: trunk
timestamp: Thu 2013-08-08 12:44:07 +0200
message:
  lisp/frameset.el: Doc fixes.
modified:
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/frameset.el               frameset.el-20130802043218-tfwraxv1c2zlibpw-1

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2013-08-08 09:54:29 +0000
+++ b/lisp/ChangeLog    2013-08-08 10:44:07 +0000
@@ -8,6 +8,8 @@
        (frameset-p, frameset-version, frameset-timestamp, frameset-app)
        (frameset-name, frameset-description, frameset-properties)
        (frameset-states): Add docstring.
+       (frameset-session-filter-alist, frameset-persistent-filter-alist)
+       (frameset-filter-alist): Doc fixes.
 
 2013-08-08  Juanma Barranquero  <address@hidden>
 

=== modified file 'lisp/frameset.el'
--- a/lisp/frameset.el  2013-08-08 09:54:29 +0000
+++ b/lisp/frameset.el  2013-08-08 10:44:07 +0000
@@ -432,7 +432,7 @@
     (minibuffer      . frameset-filter-minibuffer)
     (top             . frameset-filter-iconified))
   "Minimum set of parameters to filter for live (on-session) framesets.
-See `frameset-filter-alist' for a full description.")
+DO NOT MODIFY.  See `frameset-filter-alist' for a full description.")
 
 ;;;###autoload
 (defvar frameset-persistent-filter-alist
@@ -458,7 +458,7 @@
      (window-system      . :never))
    frameset-session-filter-alist)
   "Parameters to filter for persistent framesets.
-See `frameset-filter-alist' for a full description.")
+DO NOT MODIFY.  See `frameset-filter-alist' for a full description.")
 
 ;;;###autoload
 (defvar frameset-filter-alist frameset-persistent-filter-alist
@@ -467,6 +467,15 @@
 This alist is the default value of the FILTERS argument of
 `frameset-save' and `frameset-restore' (which see).
 
+Initially, `frameset-filter-alist' is set to, and shares the value of,
+`frameset-persistent-filter-alist'.  You can override any item in
+this alist by `push'ing a new item onto it.  If, for some reason, you
+intend to modify existing values, do
+
+  (setq frameset-filter-alist (copy-tree frameset-filter-alist))
+
+before changing anything.
+
 On saving, PARAMETERS is the parameter alist of each frame processed,
 and FILTERED is the parameter alist that gets saved to the frameset.