From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Fri, 2 Aug 2019 12:46:48 +0000 (+0200)
Subject: pdb doc clarification
X-Git-Tag: emacs-27.0.90~1759
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3975eb46150a6c896319b350112c036c678cfc38;p=emacs.git

pdb doc clarification

* lisp/progmodes/gud.el (pdb): Clarify what the parameters mean
(bug#20106).
---

diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el
index 6b152b7b902..b6a4ad3cd0c 100644
--- a/lisp/progmodes/gud.el
+++ b/lisp/progmodes/gud.el
@@ -1681,9 +1681,15 @@ This should be an executable on your path, or an absolute file name."
 
 ;;;###autoload
 (defun pdb (command-line)
-  "Run pdb on program FILE in buffer `*gud-FILE*'.
-The directory containing FILE becomes the initial working directory
-and source-file directory for your debugger."
+  "Run COMMAND-LINE in the `*gud-FILE*' buffer.
+
+COMMAND-LINE should include the pdb executable
+name (`gud-pdb-command-name') and the file to be debugged.
+
+If called interactively, the command line will be prompted for.
+
+The directory containing this file becomes the initial working
+directory and source-file directory for your debugger."
   (interactive
    (list (gud-query-cmdline 'pdb)))