]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve doc strings of 'gud-gdb' and 'gdb'
authorEli Zaretskii <eliz@gnu.org>
Mon, 1 Aug 2016 19:58:37 +0000 (22:58 +0300)
committerEli Zaretskii <eliz@gnu.org>
Mon, 1 Aug 2016 19:58:37 +0000 (22:58 +0300)
* lisp/progmodes/gdb-mi.el (gdb):
* lisp/progmodes/gud.el (gud-gdb): Doc fix.  (Bug#24125)

lisp/progmodes/gdb-mi.el
lisp/progmodes/gud.el

index 5ad101df7bf2d36dcf96727e0c0dcff3bcaf1c9a..d243650d73aa45c6d27016256df80d7ec5ae7b5b 100644 (file)
@@ -673,14 +673,18 @@ NOARG must be t when this macro is used outside `gud-def'"
 
 ;;;###autoload
 (defun gdb (command-line)
-  "Run gdb on program FILE in buffer *gud-FILE*.
-The directory containing FILE becomes the initial working directory
-and source-file directory for your debugger.
-
-COMMAND-LINE is the shell command for starting the gdb session.
-It should be a string consisting of the name of the gdb
-executable followed by command line options.  The command line
-options should include \"-i=mi\" to use gdb's MI text interface.
+  "Run gdb passing it COMMAND-LINE as arguments.
+
+If COMMAND-LINE names a program FILE to debug, gdb will run in
+a buffer named *gud-FILE*, and the directory containing FILE
+becomes the initial working directory and source-file directory
+for your debugger.
+If COMMAND-LINE requests that gdb attaches to a process PID, gdb
+will run in *gud-PID*, otherwise it will run in *gud*; in these
+cases the initial working directory is the default-directory of
+the buffer in which this command was invoked.
+
+COMMAND-LINE should include \"-i=mi\" to use gdb's MI text interface.
 Note that the old \"--annotate\" option is no longer supported.
 
 If option `gdb-many-windows' is nil (the default value) then gdb just
index 356cd3e05329a90f0b72836f21d2b944606ce787..0ac48f5f52739a6de6aa927c48ec7c660cec5e68 100644 (file)
@@ -733,9 +733,15 @@ It should return a list of completion strings.")
 ;; The old gdb command (text command mode).  The new one is in gdb-mi.el.
 ;;;###autoload
 (defun gud-gdb (command-line)
-  "Run gdb on program FILE in buffer *gud-FILE*.
-The directory containing FILE becomes the initial working
-directory and source-file directory for your debugger."
+  "Run gdb passing it COMMAND-LINE as arguments.
+If COMMAND-LINE names a program FILE to debug, gdb will run in
+a buffer named *gud-FILE*, and the directory containing FILE
+becomes the initial working directory and source-file directory
+for your debugger.
+If COMMAND-LINE requests that gdb attaches to a process PID, gdb
+will run in *gud-PID*, otherwise it will run in *gud*; in these
+cases the initial working directory is the default-directory of
+the buffer in which this command was invoked."
   (interactive (list (gud-query-cmdline 'gud-gdb)))
 
   (when (and gud-comint-buffer