diff mbox series

[v8,2/6] GDB: Add missing inline documentation for `add_setshow_cmd_full'

Message ID alpine.DEB.2.20.2211240457530.19931@tpp.orcam.me.uk
State Superseded
Headers
Series gdb: split array and string limiting options |

Commit Message

Maciej W. Rozycki Nov. 24, 2022, 11:22 a.m. UTC 
  Complement commit 1d7fe7f01b93 ("gdb: Introduce setting construct 
within cmd_list_element") and add missing description for 
`add_setshow_cmd_full'.
---
New change in v8, split off from 2/4 in v7.
---
 gdb/cli/cli-decode.c |   12 ++++++++++++
 1 file changed, 12 insertions(+)

gdb-setshow-cmd-full-doc.diff

Comments

Simon Marchi Jan. 12, 2023, 6:40 p.m. UTC | #1 
On 11/24/22 06:22, Maciej W. Rozycki wrote:
> Complement commit 1d7fe7f01b93 ("gdb: Introduce setting construct 
> within cmd_list_element") and add missing description for 
> `add_setshow_cmd_full'.
> ---
> New change in v8, split off from 2/4 in v7.
> ---
>  gdb/cli/cli-decode.c |   12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> gdb-setshow-cmd-full-doc.diff
> Index: src/gdb/cli/cli-decode.c
> ===================================================================
> --- src.orig/gdb/cli/cli-decode.c
> +++ src/gdb/cli/cli-decode.c
> @@ -580,6 +580,18 @@ add_setshow_cmd_full_erased (const char
>    return {set, show};
>  }
>  
> +/* Add element named NAME to both the command SET_LIST and SHOW_LIST.

"to both the command" doesn't really make sense.  I'd say "to both
command lists SET_LIST and SHOW_LIST", or "to both lists SET_LIST and
SHOW_LIST".

I see that this text comes from add_setshow_cmd_full_erased, it can be
fixed there too.  Also, it would be fine to just document the duplicated
parameters in one function and refer to that in the other function.

Simon
diff mbox series

Patch

Index: src/gdb/cli/cli-decode.c
===================================================================
--- src.orig/gdb/cli/cli-decode.c
+++ src/gdb/cli/cli-decode.c
@@ -580,6 +580,18 @@  add_setshow_cmd_full_erased (const char
   return {set, show};
 }
 
+/* Add element named NAME to both the command SET_LIST and SHOW_LIST.
+   THECLASS is as in add_cmd.  VAR_TYPE is the kind of thing we are
+   setting.  VAR is address of the variable being controlled by this
+   command.  If nullptr is given as VAR, then both SET_SETTING_FUNC and
+   GET_SETTING_FUNC must be provided.  SET_SETTING_FUNC and GET_SETTING_FUNC
+   are callbacks used to access and modify the underlying property,
+   whatever its storage is.  SET_FUNC and SHOW_FUNC are the callback
+   functions (if non-NULL).  SET_DOC, SHOW_DOC and HELP_DOC are the
+   documentation strings.
+
+   Return the newly created set and show commands.  */
+
 template<typename T>
 static set_show_commands
 add_setshow_cmd_full (const char *name,