]> git.eshelyaron.com Git - emacs.git/commitdiff
pdb doc clarification
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 2 Aug 2019 12:46:48 +0000 (14:46 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 2 Aug 2019 12:46:55 +0000 (14:46 +0200)
* lisp/progmodes/gud.el (pdb): Clarify what the parameters mean
(bug#20106).

lisp/progmodes/gud.el

index 6b152b7b902e3b9a7743769fa4a310a360832638..b6a4ad3cd0c939a949df90e33c940450708fca29 100644 (file)
@@ -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)))