[binutils-gdb] [pre-commit] Make gdb/doc codespell-clean
Tom de Vries via Binutils-cvs <[email protected]>
| Newsgroups | gmane.comp.gnu.binutils.cvs |
|---|---|
| Message-ID | <[email protected]> |
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=198d9054c3256a1b614e842a3c9760875a4dbcc3 commit 198d9054c3256a1b614e842a3c9760875a4dbcc3 Author: Tom de Vries <[email protected]> Date: Mon Jun 1 14:33:48 2026 +0200 [pre-commit] Make gdb/doc codespell-clean Fix typos in gdb/doc and replace "SME" with "sme" in gdb/contrib/codespell-ignore-words.txt, and add "wither" and "stap". Diff: --- .pre-commit-config.yaml | 2 +- gdb/contrib/codespell-ignore-words.txt | 4 ++- gdb/doc/gdb.texinfo | 58 ++++++++++++++++++++++++---------- 3 files changed, 46 insertions(+), 18 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 325287ee440..fe8466433ac 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -71,7 +71,7 @@ repos: rev: v2.4.2 hooks: - id: codespell - files: '^(gdbsupport|gdbserver|gdb/(stubs|features|nat|contrib|dwarf2|tui|target|data-directory|po|system-gdbinit|mi|syscalls|arch|regformats|compile|python|guile|config|unittests|cli|testsuite/gdb.(ctf|dap|debuginfod|gdb|go|guile|mi|modula2|objc|opencl|opt|pascal|perf|replay|reverse|rocm|server|stabs|testsuite|tui|xml)))/' + files: '^(gdbsupport|gdbserver|gdb/(doc|stubs|features|nat|contrib|dwarf2|tui|target|data-directory|po|system-gdbinit|mi|syscalls|arch|regformats|compile|python|guile|config|unittests|cli|testsuite/gdb.(ctf|dap|debuginfod|gdb|go|guile|mi|modula2|objc|opencl|opt|pascal|perf|replay|reverse|rocm|server|stabs|testsuite|tui|xml)))/' args: [--toml, gdb/pyproject.toml] - id: codespell name: codespell-log diff --git a/gdb/contrib/codespell-ignore-words.txt b/gdb/contrib/codespell-ignore-words.txt index b6f80f3ce52..0594fc39a45 100644 --- a/gdb/contrib/codespell-ignore-words.txt +++ b/gdb/contrib/codespell-ignore-words.txt @@ -1,6 +1,8 @@ configury -SME +sme Synopsys aranges fpr parm +wither +stap diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 9de2c7a299e..a698b2b8451 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -384,6 +384,7 @@ or your friends (or enemies, to be evenhanded) have been unfairly omitted from this list, we would like to add your names! @end quotation +@c codespell:ignore-begin So that they may not regard their many labors as thankless, we particularly thank those who shepherded @value{GDBN} through major releases: @@ -562,6 +563,7 @@ Stafford Horne. Weimin Pan, David Faust and Jose E. Marchesi contributed support for the Linux kernel BPF virtual architecture. This work was sponsored by Oracle. +@c codespell:ignore-end @node Sample Session @chapter A Sample @value{GDBN} Session @@ -4978,11 +4980,14 @@ language of the breakpoint's function, other values mean to use the manually specified language (see @ref{Manually, ,Set Language Manually}). The syntax of the regular expression is the standard one used with tools -like @file{grep}. Note that this is different from the syntax used by +like @file{grep}. +@c codespell:ignore-begin +Note that this is different from the syntax used by shells, so for instance @code{foo*} matches all functions that include -an @code{fo} followed by zero or more @code{o}s. There is an implicit -@code{.*} leading and trailing the regular expression you supply, so to -match only functions that begin with @code{foo}, use @code{^foo}. +an @code{fo} followed by zero or more @code{o}s. +@c codespell:ignore-end +There is an implicit @code{.*} leading and trailing the regular expression you +supply, so to match only functions that begin with @code{foo}, use @code{^foo}. @cindex non-member C@t{++} functions, set breakpoint in When debugging C@t{++} programs, @code{rbreak} is useful for setting @@ -10019,7 +10024,9 @@ regular expression. @table @code @kindex search @kindex forward-search +@c codespell:ignore-begin @kindex fo @r{(@code{forward-search})} +@c codespell:ignore-end @cindex @code{$_} and commands that search source files @item forward-search @var{regexp} @itemx search @var{regexp} @@ -10027,8 +10034,11 @@ The command @samp{forward-search @var{regexp}} checks each line, starting with the one following the last line listed, for a match for @var{regexp}. It lists the line that is found and saves it in the convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience -Variables}). You can use the synonym @samp{search @var{regexp}} -or abbreviate the command name as @code{fo}. +Variables}). +@c codespell:ignore-begin +You can use the synonym @samp{search @var{regexp}} or abbreviate the command +name as @code{fo}. +@c codespell:ignore-end @kindex reverse-search @item reverse-search @var{regexp} @@ -27315,7 +27325,7 @@ exception. When IBT is enabled, the CPU implements a state machine that tracks indirect @code{JMP} and @code{CALL} instructions. The state machine can be either IDLE or WAIT_FOR_ENDBRANCH. When a @code{JMP} or @code{CALL} is -executed the state machine chages to the WAIT_FOR_ENDBRANCH state. In +executed the state machine changes to the WAIT_FOR_ENDBRANCH state. In WAIT_FOR_ENDBRANCH state the next instruction in the program stream must be an @code{ENDBR} instruction, otherwise the processor signals a control protection exception. After executing a @code{ENDBR} instruction @@ -28433,7 +28443,7 @@ palette. Integers 16-255 are the indexes into xterm extended 256-color palette dependent and sometimes can be changed with OSC 4 sequences, e.g. "\033]4;1;rgb:00/FF/00\033\\". A hexadecimal 24-bit TrueColor is specified in the format @samp{#RRGGBB} where RR, GG and BB are the 2-digit hexadecimal -integers specifiing the intensity of the red, green and blue color components, +integers specifying the intensity of the red, green and blue color components, respectively. It is the responsibility of the user to verify that the terminal supports @@ -34285,12 +34295,14 @@ The corresponding @value{GDBN} command is @samp{cd}. @subsubheading Example +@c codespell:ignore-begin @smallexample (gdb) -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb ^done (gdb) @end smallexample +@c codespell:ignore-end @findex -environment-directory @@ -34325,6 +34337,7 @@ The corresponding @value{GDBN} command is @samp{dir}. @subsubheading Example +@c codespell:ignore-begin @smallexample (gdb) -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb @@ -34340,6 +34353,7 @@ The corresponding @value{GDBN} command is @samp{dir}. ^done,source-path="$cdir:$cwd" (gdb) @end smallexample +@c codespell:ignore-end @findex -environment-path @@ -34376,6 +34390,7 @@ The corresponding @value{GDBN} command is @samp{path}. @subsubheading Example +@c codespell:ignore-begin @smallexample (gdb) -environment-path @@ -34388,6 +34403,7 @@ The corresponding @value{GDBN} command is @samp{path}. ^done,path="/usr/local/bin:/usr/bin" (gdb) @end smallexample +@c codespell:ignore-end @findex -environment-pwd @@ -34407,12 +34423,14 @@ The corresponding @value{GDBN} command is @samp{pwd}. @subsubheading Example +@c codespell:ignore-begin @smallexample (gdb) -environment-pwd ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb" (gdb) @end smallexample +@c codespell:ignore-end @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @node GDB/MI Thread Commands @@ -38323,12 +38341,14 @@ The corresponding @value{GDBN} command is @samp{file}. @subsubheading Example +@c codespell:ignore-begin @smallexample (gdb) -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx ^done (gdb) @end smallexample +@c codespell:ignore-end @findex -file-exec-file @@ -38352,12 +38372,14 @@ The corresponding @value{GDBN} command is @samp{exec-file}. @subsubheading Example +@c codespell:ignore-begin @smallexample (gdb) -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx ^done (gdb) @end smallexample +@c codespell:ignore-end @ignore @@ -38629,12 +38651,14 @@ The corresponding @value{GDBN} command is @samp{symbol-file}. @subsubheading Example +@c codespell:ignore-begin @smallexample (gdb) -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx ^done (gdb) @end smallexample +@c codespell:ignore-end @ignore @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -41933,11 +41957,13 @@ This command is useful for debugging the Agent Expression mechanism (@pxref{Agent Expressions}). The @samp{agent} version produces an expression useful for data collection, such as by tracepoints, while @samp{maint agent-eval} produces an expression that evaluates directly -to a result. For instance, a collection expression for @code{globa + -globb} will include bytecodes to record four bytes of memory at each -of the addresses of @code{globa} and @code{globb}, while discarding -the result of the addition, while an evaluation expression will do the -addition and return the sum. +to a result. +@c codespell:ignore-begin +For instance, a collection expression for @code{globa + globb} will include +bytecodes to record four bytes of memory at each of the addresses of +@code{globa} and @code{globb}, while discarding the result of the addition, +while an evaluation expression will do the addition and return the sum. +@c codespell:ignore-end If @code{-at} is given, generate remote agent bytecode for all the addresses to which @var{linespec} resolves (@pxref{Linespec Locations}). @@ -43263,7 +43289,7 @@ The two-digit @var{checksum} is computed as the modulo 256 sum of all characters between the leading @samp{$} and the trailing @samp{#} (an eight bit unsigned checksum). -Implementors should note that prior to @value{GDBN} 5.0 the protocol +Implementers should note that prior to @value{GDBN} 5.0 the protocol specification also included an optional two-digit @var{sequence-id}: @smallexample @@ -43308,7 +43334,7 @@ Fields within the packet should be separated using @samp{,} @samp{;} or @samp{:}. Except where otherwise noted all numbers are represented in @sc{hex} with leading zeros suppressed. -Implementors should note that prior to @value{GDBN} 5.0, the character +Implementers should note that prior to @value{GDBN} 5.0, the character @samp{:} could not appear as the third character in a packet (as it would potentially conflict with the @var{sequence-id}). @@ -45291,7 +45317,7 @@ command (@pxref{Remote Configuration, set remote thread-options}). execution. Invalid commands should be reported using the output string. Before the final result packet, the target may also respond with a number of intermediate @samp{O@var{output}} console output -packets. @emph{Implementors should note that providing access to a +packets. @emph{Implementers should note that providing access to a stubs's interpreter may have security implications}. Reply: