[Emacs-diffs] /srv/bzr/emacs/trunk r107195: Doc fixes for browse-url

[Glenn Morris]

------------------------------------------------------------
revno: 107195
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Wed 2012-02-08 22:14:22 -0500
message:
  Doc fixes for browse-url
  
  * lisp/net/browse-url.el (browse-url-can-use-xdg-open, browse-url-xdg-open):
  Doc fixes.
modified:
  lisp/ChangeLog
  lisp/net/browse-url.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-02-09 02:40:41 +0000
+++ b/lisp/ChangeLog    2012-02-09 03:14:22 +0000
@@ -1,5 +1,8 @@
 2012-02-09  Glenn Morris  <address@hidden>
 
+       * net/browse-url.el (browse-url-can-use-xdg-open)
+       (browse-url-xdg-open): Doc fixes.
+
        * electric.el (electric-indent-mode, electric-pair-mode)
        (electric-layout-rules, electric-layout-mode): Doc fixes.
        (electric-pair-pairs, electric-pair-skip-self): Add :version tags.

=== modified file 'lisp/net/browse-url.el'
--- a/lisp/net/browse-url.el    2012-01-19 07:21:25 +0000
+++ b/lisp/net/browse-url.el    2012-02-09 03:14:22 +0000
@@ -944,7 +944,9 @@
    url args))
 
 (defun browse-url-can-use-xdg-open ()
-  "Check if xdg-open can be used, i.e. we are on Gnome, KDE, Xfce4 or LXDE."
+  "Return non-nil if the \"xdg-open\" program can be used.
+xdg-open is a desktop utility that calls your preferred web browser.
+This requires you to be running either Gnome, KDE, Xfce4 or LXDE."
   (and (getenv "DISPLAY")
        (executable-find "xdg-open")
        ;; xdg-open may call gnome-open and that does not wait for its child
@@ -974,7 +976,10 @@
 
 
 ;;;###autoload
-(defun browse-url-xdg-open (url &optional new-window)
+(defun browse-url-xdg-open (url &optional ignored)
+  "Pass the specified URL to the \"xdg-open\" command.
+xdg-open is a desktop utility that calls your preferred web browser.
+The optional argument IGNORED is not used."
   (interactive (browse-url-interactive-arg "URL: "))
   (call-process "xdg-open" nil 0 nil url))