[Emacs-diffs] trunk r116412: Some package doc updates

[Glenn Morris]

------------------------------------------------------------
revno: 116412
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Tue 2014-02-11 20:20:34 -0500
message:
  Some package doc updates
  
  * doc/emacs/help.texi (Package Keywords): Mention describe-package buttons.
  
  * doc/emacs/package.texi (Package Menu): Mention package-menu-filter.
  
  * lisp/emacs-lisp/package.el (package-menu-mode-map): Tweak menu.
  (package-menu-filter): Rename from package-menu-filter-interactive.
  Doc fix.
  
  * etc/NEWS: Related edits.  Copyedit.
modified:
  doc/emacs/ChangeLog            changelog-20091113204419-o5vbwnq5f7feedwu-6227
  doc/emacs/help.texi            help.texi-20091113204419-o5vbwnq5f7feedwu-6256
  doc/emacs/package.texi         package.texi-20110825190024-lpvyu1zke977csqu-1
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/emacs-lisp/package.el     package.el-20100617020707-ybavz666awsxwin6-2

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2014-02-11 06:34:29 +0000
+++ b/doc/emacs/ChangeLog       2014-02-12 01:20:34 +0000
@@ -1,3 +1,9 @@
+2014-02-12  Glenn Morris  <address@hidden>
+
+       * help.texi (Package Keywords): Mention describe-package buttons.
+
+       * package.texi (Package Menu): Mention package-menu-filter.
+
 2014-02-11  Lars Ingebrigtsen  <address@hidden>
 
        * text.texi (Editing Format Info): Use @samp for menus (bug#13736).

=== modified file 'doc/emacs/help.texi'
--- a/doc/emacs/help.texi       2014-01-01 07:43:34 +0000
+++ b/doc/emacs/help.texi       2014-02-12 01:20:34 +0000
@@ -458,7 +458,9 @@
 @kindex C-h P
   @kbd{C-h P} (@code{describe-package}) prompts for the name of a
 package, and displays a help buffer describing the attributes of the
-package and the features that it implements.
+package and the features that it implements.  The buffer lists the
+keywords that relate to the package in the form of buttons.  Click on
+a button to see other packages related to that keyword.
 
 @node Language Help
 @section Help for International Language Support

=== modified file 'doc/emacs/package.texi'
--- a/doc/emacs/package.texi    2014-01-01 07:43:34 +0000
+++ b/doc/emacs/package.texi    2014-02-12 01:20:34 +0000
@@ -126,6 +126,12 @@
 Refresh the package list (@code{package-menu-refresh}).  This fetches
 the list of available packages from the package archive again, and
 recomputes the package list.
+
address@hidden f
+Filter the package list (@code{package-menu-filter}).  This prompts
+for a keyword (e.g., @samp{games}), then shows only the packages
+that relate to that keyword.  To restore the full package list,
+type @kbd{q}.
 @end table
 
 @noindent

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-02-09 04:24:02 +0000
+++ b/etc/NEWS  2014-02-12 01:20:34 +0000
@@ -197,16 +197,15 @@
 These are normal hooks run when an Emacs frame gains or loses input focus.
 
 ---
-*** Emacs can now draw dividers between adjacent windows.  To put
-dividers between side-by-side windows customize the frame parameter
-right-divider-width to some positive integer.  To put dividers between
-vertically stacked windows set the frame parameter bottom-divider-width
-to some positive integer.  Dividers can be dragged with the mouse and
-show a corresponding cursor when the mouse hovers over them.  The
-appearance of dividers can be changed by customizing the basic faces
-window-divider, window-divider-first-pixel and window-divider-last-pixel
-where the latter two are useful to provide a 3D effect or to better set
-dividers apart from surrounding display objects.
+*** Emacs can now draw dividers between adjacent windows.
+To put dividers between side-by-side/vertically stacked windows
+customize the frame parameter `right-divider-width'/`bottom-divider-width'
+to some positive integer.  You can drag dividers with the mouse
+(they show a corresponding cursor when the mouse hovers over them).
+You can change the appearance of dividers by customizing the faces
+`window-divider', `window-divider-first-pixel', and
+`window-divider-last-pixel'.  The last two are useful to provide a 3D
+effect, or to better distinguish dividers from surrounding display objects.
 
 ---
 *** `split-window' is now a non-interactive function, not a command.
@@ -673,19 +672,21 @@
 
 ** Package
 
++++
+*** In the `list-packages' buffer, you can use `f' (`package-menu-filter')
+to filter the list of packages by a keyword.
+
++++
+*** In the `describe-package' buffer, there are now buttons listing the 
+keywords related to the package.  Click on a button to see other packages
+related to that keyword.
+
+---
 *** The format of `archive-contents' files, generated by package
 repositories, has changed to allow a new (fifth) element in the data
 vectors, containing an associative list with extra properties.
-
-*** `describe-package' buffer uses the `:url' extra property to
-display a `Homepage' header, if it's present.
-
-*** In the buffer produced by `describe-package', there are now buttons
-listing the keywords related to that package.  You can click on them
-to see other packages related to any given keyword.
-
-*** In the *Packages* buffer, `f' or the Package->Filter menu filters
-the packages by a keyword.
+(For example, `describe-package' uses the `:url' extra property to
+display a "Homepage" header.)
 
 ---
 ** In Prolog mode, `prolog-use-smie' has been removed,

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-02-11 20:48:23 +0000
+++ b/lisp/ChangeLog    2014-02-12 01:20:34 +0000
@@ -1,3 +1,9 @@
+2014-02-12  Glenn Morris  <address@hidden>
+
+       * emacs-lisp/package.el (package-menu-mode-map): Tweak menu.
+       (package-menu-filter): Rename from package-menu-filter-interactive.
+       Doc fix.
+
 2014-02-11  Juanma Barranquero  <address@hidden>
 
        * frameset.el (frameset--jump-to-register): Select the required
@@ -73,9 +79,6 @@
        (custom-buffer-create): Doc fix (bug#11122).
        (custom-sort-items): Doc fix (bug#11121).
 
-       * dired-aux.el (dired-copy-file-recursive): Remove slighly
-       misleading comment (bug#11328).
-
        * repeat.el (repeat-message-function): Reword doc slightly (bug#11619).
 
        * icomplete.el (icomplete-with-completion-tables): Doc fix (bug#11654).

=== modified file 'lisp/emacs-lisp/package.el'
--- a/lisp/emacs-lisp/package.el        2014-01-22 19:22:45 +0000
+++ b/lisp/emacs-lisp/package.el        2014-02-12 01:20:34 +0000
@@ -1570,7 +1570,7 @@
     (define-key map "i" 'package-menu-mark-install)
     (define-key map "U" 'package-menu-mark-upgrades)
     (define-key map "r" 'package-menu-refresh)
-    (define-key map "f" 'package-menu-filter-interactive)
+    (define-key map "f" 'package-menu-filter)
     (define-key map "~" 'package-menu-mark-obsolete-for-deletion)
     (define-key map "x" 'package-menu-execute)
     (define-key map "h" 'package-menu-quick-help)
@@ -1579,9 +1579,6 @@
     (define-key menu-map [mq]
       '(menu-item "Quit" quit-window
                  :help "Quit package selection"))
-    (define-key menu-map [mf]
-      '(menu-item "Filter" package-menu-filter-interactive
-                 :help "Filter package selection (q to go back)"))
     (define-key menu-map [s1] '("--"))
     (define-key menu-map [mn]
       '(menu-item "Next" next-line
@@ -1606,6 +1603,9 @@
       '(menu-item "Mark Upgradable Packages" package-menu-mark-upgrades
                  :help "Mark packages that have a newer version for 
upgrading"))
     (define-key menu-map [s3] '("--"))
+    (define-key menu-map [mf]
+      '(menu-item "Filter Package List..." package-menu-filter
+                 :help "Filter package selection (q to go back)"))
     (define-key menu-map [mg]
       '(menu-item "Update Package List" revert-buffer
                  :help "Update the list of packages"))
@@ -2120,8 +2120,12 @@
       (package-menu--generate nil packages keywords))
     (switch-to-buffer buf)))
 
-(defun package-menu-filter-interactive (keyword)
-  "Filter the *Packages* buffer."
+;; package-menu--generate rebinds "q" on the fly, so we have to
+;; hard-code the binding in the doc-string here.
+(defun package-menu-filter (keyword)
+  "Filter the *Packages* buffer.
+Show only those items that relate to the specified KEYWORD.
+To restore the full package list, type `q'."
   (interactive (list (completing-read "Keyword: " (package-all-keywords))))
   (package-show-package-list t (list keyword)))