Patchwork [2/2] Fix doc of AVR-specific command "info io_registers"

login
register
mail settings
Submitter Simon Marchi
Date Dec. 3, 2019, 6:20 a.m.
Message ID <20191203062031.2844278-2-simon.marchi@polymtl.ca>
Download mbox | patch
Permalink /patch/36455/
State New
Headers show

Comments

Simon Marchi - Dec. 3, 2019, 6:20 a.m.
Running the selftests on an all-targets build, I get:

    Running selftest help_doc_invariants.
    help doc broken invariant: command 'info io_registers' help doc first line is not terminated with a '.' character
    Self test failed: self-test failed at /home/simark/src/binutils-gdb/gdb/unittests/help-doc-selftests.c:95

Add a period at the end of the doc of that command, and make it a bit
nicer in general.

gdb/ChangeLog:

	* avr-tdep.c (_initialize_avr_tdep): Improve help of command
	"info io_registers".
---
 gdb/avr-tdep.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Tom Tromey - Dec. 4, 2019, 5:49 p.m.
>>>>> "Simon" == Simon Marchi <simon.marchi@polymtl.ca> writes:

Simon> gdb/ChangeLog:

Simon> 	* avr-tdep.c (_initialize_avr_tdep): Improve help of command
Simon> 	"info io_registers".

Thanks, this looks good to me.

Tom

Patch

diff --git a/gdb/avr-tdep.c b/gdb/avr-tdep.c
index 6d11ee1618cc..61a0a5dd52ea 100644
--- a/gdb/avr-tdep.c
+++ b/gdb/avr-tdep.c
@@ -1629,5 +1629,5 @@  _initialize_avr_tdep (void)
      io_registers' to signify it is not available on other platforms.  */
 
   add_info ("io_registers", avr_io_reg_read_command,
-	    _("query remote avr target for io space register values"));
+	    _("Query remote AVR target for I/O space register values."));
 }