[2/2] Improve comments in print-utils.h.
Commit Message
Since I had to look at these function comments to fix the RISC-V ARI warnings,
I noticed that they make no sense. The pulongest and plongest comments are
swapped. phex is missing a comment. And phex_nz doesn't mention how it is
different from phex.
* gdbsupport/print-utils.h (pulongest): Fix comment.
(plongest): Likewise.
(phex): Add missing comment, mention leading zeros.
(phex_nz): Add mention of no leading zeros to comment.
---
gdb/gdbsupport/print-utils.h | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
@@ -24,20 +24,23 @@
cell. */
#define PRINT_CELL_SIZE 50
-/* %d for LONGEST. The result is stored in a circular static buffer,
+/* %u for ULONGEST. The result is stored in a circular static buffer,
NUMCELLS deep. */
extern char *pulongest (ULONGEST u);
-/* %u for ULONGEST. The result is stored in a circular static buffer,
+/* %d for LONGEST. The result is stored in a circular static buffer,
NUMCELLS deep. */
extern char *plongest (LONGEST l);
+/* Convert a ULONGEST into a HEX string, like %lx, with leading zeros.
+ The result is stored in a circular static buffer, NUMCELLS deep. */
+
extern char *phex (ULONGEST l, int sizeof_l);
-/* Convert a ULONGEST into a HEX string, like %lx. The result is
- stored in a circular static buffer, NUMCELLS deep. */
+/* Convert a ULONGEST into a HEX string, like %lx, without leading zeros.
+ The result is stored in a circular static buffer, NUMCELLS deep. */
extern char *phex_nz (ULONGEST l, int sizeof_l);