]> code.delx.au - gnu-emacs/commitdiff
Some package doc updates
authorGlenn Morris <rgm@gnu.org>
Wed, 12 Feb 2014 01:20:34 +0000 (20:20 -0500)
committerGlenn Morris <rgm@gnu.org>
Wed, 12 Feb 2014 01:20:34 +0000 (20:20 -0500)
* 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.

doc/emacs/ChangeLog
doc/emacs/help.texi
doc/emacs/package.texi
etc/NEWS
lisp/ChangeLog
lisp/emacs-lisp/package.el

index 034322117d9a4aa1d898d12a7f2f8567db933bdc..0a17567865df17f10a412c5ea3afee040addc271 100644 (file)
@@ -1,3 +1,9 @@
+2014-02-12  Glenn Morris  <rgm@gnu.org>
+
+       * help.texi (Package Keywords): Mention describe-package buttons.
+
+       * package.texi (Package Menu): Mention package-menu-filter.
+
 2014-02-11  Lars Ingebrigtsen  <larsi@gnus.org>
 
        * text.texi (Editing Format Info): Use @samp for menus (bug#13736).
index 5eac4d8d985e7e68ceed1d014b013293f01d716f..11694191f9c4cbdd5d5e98088995b73046f44bc9 100644 (file)
@@ -458,7 +458,9 @@ buffer (@pxref{Package Menu}).
 @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
index aba63d4337aa695ec2c829b690b4ea03d67cdd8d..dee1210086ce41c99c1e71c02b3dc321707b9e0a 100644 (file)
@@ -126,6 +126,12 @@ dependencies; also, delete all packages marked with @kbd{d}
 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.
+
+@item 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
index a82e1bbc9736a4ff827512fb75e6b617c4a2ecdb..d656b69f538afd5b639d43d69bc054a882335c78 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -197,16 +197,15 @@ command `frame-configuration-to-register' still exists, but is unbound.
 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 @@ Use `electric-indent-mode' instead.
 
 ** 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,
index ab358fdb0711085578c3688087f3665a694a1bf7..5a7bd6bceb5e0b4f159b4471b241029d4ac947eb 100644 (file)
@@ -1,3 +1,9 @@
+2014-02-12  Glenn Morris  <rgm@gnu.org>
+
+       * 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  <lekktu@gmail.com>
 
        * 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).
index bc8651641ac023fa56e24a59c4c24c253ad27fc1..b15ae6f1376e3de2de4c5dd44f6c2ba96888bf43 100644 (file)
@@ -1570,7 +1570,7 @@ If optional arg NO-ACTIVATE is non-nil, don't activate packages."
     (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 @@ If optional arg NO-ACTIVATE is non-nil, don't activate packages."
     (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 @@ If optional arg NO-ACTIVATE is non-nil, don't activate packages."
       '(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 @@ shown."
       (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)))