Commit baa7abde authored by Eli Zaretskii's avatar Eli Zaretskii
Browse files

Improve doc strings of 'gud-gdb' and 'gdb'

* lisp/progmodes/gdb-mi.el (gdb):
* lisp/progmodes/gud.el (gud-gdb): Doc fix.  (Bug#24125)
parent aa4271ab
...@@ -673,14 +673,18 @@ NOARG must be t when this macro is used outside `gud-def'" ...@@ -673,14 +673,18 @@ NOARG must be t when this macro is used outside `gud-def'"
;;;###autoload ;;;###autoload
(defun gdb (command-line) (defun gdb (command-line)
"Run gdb on program FILE in buffer *gud-FILE*. "Run gdb passing it COMMAND-LINE as arguments.
The directory containing FILE becomes the initial working directory
and source-file directory for your debugger. If COMMAND-LINE names a program FILE to debug, gdb will run in
a buffer named *gud-FILE*, and the directory containing FILE
COMMAND-LINE is the shell command for starting the gdb session. becomes the initial working directory and source-file directory
It should be a string consisting of the name of the gdb for your debugger.
executable followed by command line options. The command line If COMMAND-LINE requests that gdb attaches to a process PID, gdb
options should include \"-i=mi\" to use gdb's MI text interface. 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. Note that the old \"--annotate\" option is no longer supported.
If option `gdb-many-windows' is nil (the default value) then gdb just If option `gdb-many-windows' is nil (the default value) then gdb just
......
...@@ -733,9 +733,15 @@ It should return a list of completion strings.") ...@@ -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. ;; The old gdb command (text command mode). The new one is in gdb-mi.el.
;;;###autoload ;;;###autoload
(defun gud-gdb (command-line) (defun gud-gdb (command-line)
"Run gdb on program FILE in buffer *gud-FILE*. "Run gdb passing it COMMAND-LINE as arguments.
The directory containing FILE becomes the initial working If COMMAND-LINE names a program FILE to debug, gdb will run in
directory and source-file directory for your debugger." 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))) (interactive (list (gud-query-cmdline 'gud-gdb)))
(when (and gud-comint-buffer (when (and gud-comint-buffer
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment