Re: [PATCH 2/2] gdb/python: improve formatting of help text for user defined commands

[Lancelot SIX <lsix@lancelotsix.com>]

Hi,

> +/* See python-internal.h.  */
> +
> +gdb::unique_xmalloc_ptr<char>
> +gdbpy_fix_doc_string_indentation (gdb::unique_xmalloc_ptr<char> doc)
> +{
> +  /* A structure used to track the white-space information on each line of
> +     DOC.  */
> +  struct line_whitespace
> +  {
> +    /* Constructor.  OFFSET is the offset from the content_start of DOC, WS_COUNT
> +       is the number of whitespace characters starting at OFFSET,
> +       NON_WS_COUNT is the number of characters following WS_COUNT, this
> +       count can include additional white-space characters, but the first
> +       character of this sequence will always be non-white-space.  LAST is
> +       true if this is the last line of DOC, otherwise LAST is false.  */

It looks like the comment mentions parameters which do not exist :
NON_WS_COUNT and LAST.  Are those from a previous implementation?

> +    line_whitespace (size_t offset, int ws_count)
> +      : m_offset (offset),
> +	m_ws_count (ws_count)
> +    { /* Nothing.  */ }
> diff --git a/gdb/testsuite/gdb.python/py-doc-reformat.exp b/gdb/testsuite/gdb.python/py-doc-reformat.exp
> new file mode 100644
> index 00000000000..9c203f88b4b
> --- /dev/null
> +++ b/gdb/testsuite/gdb.python/py-doc-reformat.exp
> @@ -0,0 +1,278 @@
> [...]
> +# The INPUT_DOCS must start with 2 space characters, followed by the
> +# 3-quote characters to start the doc string, and must end with the
> +# final 3-quote characters.  If this is not true then an error is
> +# thrown, and this function immediately returns.
> +proc test { input_docs expected_output } {
> +    global idx
> +
> +    set local_idx $idx
> +    incr idx
> +
> +    with_test_prefix "test ${local_idx}" {
> +
> +	verbose -log "Start of: test_cmd ${local_idx}"
> +	verbose -log "Input:\n${input_docs}"

Are those leftover from the development?

> +
> +	if { [string range $input_docs 0 4] != "  \"\"\"" } {
> +	    perror "Input string does not start with the required pattern"
> +	    return
> +	}
> +

Best,
Lancelot.