emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] emacs-25 baa7abd: Improve doc strings of 'gud-gdb' and 'gd


From: Eli Zaretskii
Subject: [Emacs-diffs] emacs-25 baa7abd: Improve doc strings of 'gud-gdb' and 'gdb'
Date: Mon, 1 Aug 2016 20:01:12 +0000 (UTC)

branch: emacs-25
commit baa7abde77e815a0645839adae1cefdb40c984a2
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    Improve doc strings of 'gud-gdb' and 'gdb'
    
    * lisp/progmodes/gdb-mi.el (gdb):
    * lisp/progmodes/gud.el (gud-gdb): Doc fix.  (Bug#24125)
---
 lisp/progmodes/gdb-mi.el |   20 ++++++++++++--------
 lisp/progmodes/gud.el    |   12 +++++++++---
 2 files changed, 21 insertions(+), 11 deletions(-)

diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el
index 5ad101d..d243650 100644
--- a/lisp/progmodes/gdb-mi.el
+++ b/lisp/progmodes/gdb-mi.el
@@ -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
diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el
index 356cd3e..0ac48f5 100644
--- a/lisp/progmodes/gud.el
+++ b/lisp/progmodes/gud.el
@@ -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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]