# HG changeset patch # User Juanma Barranquero # Date 1203991309 0 # Node ID 062c5adc0b00780082362f5a59771313b21b70e8 # Parent 88522cc27adad4be23aa215cce92c0eebdabba71 (gdb-pc-address, gdb-source-file-list, gdb-cpp-define-alist-program, gdb-mouse-jump, gdb-get-buffer-create, gdb-debug-log, gdb-set-gud-minor-mode-existing-buffers-1): Fix typos in docstrings. (gdb-pending-triggers): Reflow docstring. (gdb, gdb-init-1): Fix typos in docstrings of gud-def definitions. diff -r 88522cc27ada -r 062c5adc0b00 lisp/progmodes/gdb-ui.el --- a/lisp/progmodes/gdb-ui.el Mon Feb 25 21:15:50 2008 +0000 +++ b/lisp/progmodes/gdb-ui.el Tue Feb 26 02:01:49 2008 +0000 @@ -100,7 +100,7 @@ (defvar speedbar-initial-expansion-list-name) (defvar gdb-pc-address nil "Initialization for Assembler buffer. -Set to \"main\" at start if gdb-show-main is t.") +Set to \"main\" at start if `gdb-show-main' is t.") (defvar gdb-frame-address nil "Identity of frame for watch expression.") (defvar gdb-previous-frame-address nil) (defvar gdb-memory-address "main") @@ -109,7 +109,7 @@ (defvar gdb-frame-number nil) (defvar gdb-current-language nil) (defvar gdb-var-list nil - "List of variables in watch window. + "List of variables in watch window. Each element has the form (VARNUM EXPRESSION NUMCHILD TYPE VALUE STATUS FP) where STATUS is nil (`unchanged'), `changed' or `out-of-scope', FP the frame address for root variables.") @@ -174,14 +174,13 @@ "The most recent command item sent to gdb.") (defvar gdb-pending-triggers '() - "A list of trigger functions that have run later than their output -handlers.") + "A list of trigger functions that have run later than their output handlers.") (defvar gdb-first-post-prompt nil) (defvar gdb-version nil) (defvar gdb-locals-font-lock-keywords nil) (defvar gdb-source-file-list nil - "List of source files for the current executable") + "List of source files for the current executable.") (defconst gdb-error-regexp "\\^error,msg=\"\\(.+\\)\"") (defvar gdb-locals-font-lock-keywords-1 @@ -288,7 +287,7 @@ (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.") (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.") - (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line") + (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line.") (gud-def gud-step "step %p" "\C-s" "Step one source line with display.") (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.") (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).") @@ -333,10 +332,9 @@ :version "22.1") (defvar gdb-debug-log nil - "List of commands sent to and replies received from GDB. Most -recent commands are listed first. This list stores only the last -'gdb-debug-log-max' values. This variable is used to debug -GDB-UI.") + "List of commands sent to and replies received from GDB. +Most recent commands are listed first. This list stores only the last +`gdb-debug-log-max' values. This variable is used to debug GDB-UI.") ;;;###autoload (defcustom gdb-enable-debug nil @@ -349,7 +347,7 @@ "Shell command for generating a list of defined macros in a source file. This list is used to display the #define directive associated with an identifier as a tooltip. It works in a debug session with -GDB, when gud-tooltip-mode is t. +GDB, when `gud-tooltip-mode' is t. Set `gdb-cpp-define-alist-flags' for any include paths or predefined macros." @@ -550,7 +548,7 @@ "pp1 " (if (eq (buffer-local-value 'major-mode (window-buffer)) 'speedbar-mode) (gdb-find-watch-expression) "%e")) arg) - nil "Print the emacs s-expression.") + nil "Print the Emacs s-expression.") (define-key gud-minor-mode-map [left-margin mouse-1] 'gdb-mouse-set-clear-breakpoint) @@ -686,7 +684,7 @@ "Set execution address/line. The destination source line can be selected either by clicking with C-mouse-3 on the fringe/margin or dragging the arrow with C-mouse-1 (default bindings). -Unlike gdb-mouse-until the destination address can be before the current +Unlike `gdb-mouse-until' the destination address can be before the current line, and no execution takes place." (interactive "e") (let ((start (event-start event)) @@ -824,7 +822,7 @@ `(lambda () (gdb-var-list-children-handler ,varnum))))) (defconst gdb-var-list-children-regexp - "child={.*?name=\"\\(.*?\\)\",.*?exp=\"\\(.*?\\)\",.*?\ + "child={.*?name=\"\\(.*?\\)\",.*?exp=\"\\(.*?\\)\",.*?\ numchild=\"\\(.*?\\)\"\\(}\\|,.*?\\(type=\"\\(.*?\\)\"\\)?.*?}\\)") (defun gdb-var-list-children-handler (varnum) @@ -1032,7 +1030,7 @@ (gdb-look-for-tagged-buffer key (buffer-list)))) (defun gdb-get-buffer-create (key) - "Create a new gdb buffer of the type specified by KEY. + "Create a new gdb buffer of the type specified by KEY. The key should be one of the cars in `gdb-buffer-rules-assoc'." (or (gdb-get-buffer key) (let* ((rules (assoc key gdb-buffer-rules-assoc)) @@ -1345,7 +1343,7 @@ "An annotation handler for `prompt'. This sends the next command (if any) to gdb." (when gdb-first-prompt - (gdb-force-mode-line-update + (gdb-force-mode-line-update (propertize "initializing..." 'face font-lock-variable-name-face)) (gdb-init-1) (setq gdb-first-prompt nil)) @@ -2273,7 +2271,7 @@ (kill-all-local-variables) (setq major-mode 'gdb-frames-mode) (setq mode-name "Frames") - (setq gdb-stack-position nil) + (setq gdb-stack-position nil) (add-to-list 'overlay-arrow-variable-list 'gdb-stack-position) (setq truncate-lines t) ;; Make it easier to see overlay arrow. (setq buffer-read-only t) @@ -2602,10 +2600,10 @@ (let ((map (make-sparse-keymap))) (define-key map [header-line down-mouse-3] 'gdb-memory-format-menu-1) map) - "Keymap to select format in the header line.") + "Keymap to select format in the header line.") (defvar gdb-memory-format-menu (make-sparse-keymap "Format") - "Menu of display formats in the header line.") + "Menu of display formats in the header line.") (define-key gdb-memory-format-menu [binary] '(menu-item "Binary" gdb-memory-format-binary @@ -2664,10 +2662,10 @@ (let ((map (make-sparse-keymap))) (define-key map [header-line down-mouse-3] 'gdb-memory-unit-menu-1) map) - "Keymap to select units in the header line.") + "Keymap to select units in the header line.") (defvar gdb-memory-unit-menu (make-sparse-keymap "Unit") - "Menu of units in the header line.") + "Menu of units in the header line.") (define-key gdb-memory-unit-menu [giantwords] '(menu-item "Giant words" gdb-memory-unit-giant @@ -2830,7 +2828,7 @@ (beginning-of-line) (gud-watch))) map) - "Keymap to create watch expression of a complex data type local variable.") + "Keymap to create watch expression of a complex data type local variable.") (defconst gdb-struct-string (concat (propertize "[struct/union]" @@ -3479,7 +3477,7 @@ (defun gdb-set-gud-minor-mode-existing-buffers-1 () "Create list of source files for current GDB session. -If buffers already exist for any of these files, gud-minor-mode +If buffers already exist for any of these files, `gud-minor-mode' is set in them." (goto-char (point-min)) (while (re-search-forward gdb-source-file-regexp-1 nil t) @@ -3690,7 +3688,7 @@ (define-key map "\r" 'gud-watch) (define-key map [mouse-2] 'gud-watch) map) - "Keymap to create watch expression of a complex data type local variable.") + "Keymap to create watch expression of a complex data type local variable.") (defvar gdb-edit-locals-map-1 (let ((map (make-sparse-keymap))) @@ -3698,7 +3696,7 @@ (define-key map "\r" 'gdb-edit-locals-value) (define-key map [mouse-2] 'gdb-edit-locals-value) map) - "Keymap to edit value of a simple data type local variable.") + "Keymap to edit value of a simple data type local variable.") (defun gdb-edit-locals-value (&optional event) "Assign a value to a variable displayed in the locals buffer."