Index | Thread | Search

From:
Nir Lichtman <nir@lichtman.org>
Subject:
Fix incorrect modifier documentation in DDB man page
To:
tech@openbsd.org
Date:
Fri, 11 Oct 2024 10:59:19 +0000

Download raw body.

Thread
Problem: Currently, the DDB man page claims that modifiers can be added to registers
that are accessed as variables, and an example is given with $eax:u
The example does not work in i386 (outputs variable not found), and after a look at
the code in db_find_variable, it doesn't seem to support any modifier logic besides
a simple strcmp of the register name and the input by the user

Solution: Fix the man page to remove the section that talks about these modifiers
Also another small fix to the bottom part of the man page that incorrectly references
modifiers.


===============================================


diff --git share/man/man4/ddb.4 share/man/man4/ddb.4
index 6ca75c4d5..7411a69b8 100644
--- share/man/man4/ddb.4
+++ share/man/man4/ddb.4
@@ -1168,14 +1168,6 @@ Register names can be found with the
 .Ic show registers
 command.
 .Pp
-Some variable names are suffixed with numbers, and some may have a modifier
-following a colon immediately after the variable name.
-For example, register variables can have the
-.Ql :u
-modifier to indicate a
-user register (e.g.,
-.Ql $eax:u ) .
-.Pp
 Built-in debugger variables currently supported are:
 .Bl -tag -width 10n -compact -offset indent
 .It Va $radix
@@ -1277,16 +1269,13 @@ command.
 The last address explicitly specified.
 .It Li $ Ns Ar variable
 The value of a register or variable.
-The name may be followed by a
-.Ql \&:
-and modifiers as described above with
-.Ar identifier .
 .It Ar expr Li # Ar expr
 A binary operator which rounds up the left hand side to the next
 multiple of right hand side.
 .It Li * Ns Ar expr
 Indirection.
-It may be followed by a ':' and modifiers as described above.
+It may be followed by a ':' as described above with
+.Ar identifier .
 .El
 .Sh SEE ALSO
 .Xr ctfstrip 1 ,