From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 1256) id B7D3A3858D28; Wed, 18 Jan 2023 21:56:23 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org B7D3A3858D28 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1674078983; bh=yuGsyyT1vBql32wazEwF5p8GkcRw0Z5Z+S5n4mrotys=; h=From:To:Subject:Date:From; b=eNEVnPKeVsnnafscUTBbL8pjHy56urYuUg+wNTAcQ/FZt9qaCjQ0wN0SMv9GaEpPH mm4In4E8UeM2C01Dg1PHSA25YdsacojcbLa5o/oqTnLAwzz744g/rfGeON/aWZNGq9 nkfIvuVGZOJcRfsCpGx6ozXXGMjSKFK2U/wvB87g= Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Maciej W. Rozycki To: gdb-cvs@sourceware.org Subject: [binutils-gdb] GDB: Fix documentation for `theclass' parameters in cli-decode.c X-Act-Checkin: binutils-gdb X-Git-Author: Maciej W. Rozycki X-Git-Refname: refs/heads/master X-Git-Oldrev: bd3014572d687e6d6e9d27a46d5b19a4a5528e85 X-Git-Newrev: a58c879377f4a381c275aa7a5e208802331f4c95 Message-Id: <20230118215623.B7D3A3858D28@sourceware.org> Date: Wed, 18 Jan 2023 21:56:23 +0000 (GMT) List-Id: https://sourceware.org/git/gitweb.cgi?p=3Dbinutils-gdb.git;h=3Da58c879377f4= a381c275aa7a5e208802331f4c95 commit a58c879377f4a381c275aa7a5e208802331f4c95 Author: Maciej W. Rozycki Date: Wed Jan 18 21:54:37 2023 +0000 GDB: Fix documentation for `theclass' parameters in cli-decode.c =20 Rename CLASS to THECLASS in the documentation for `theclass' parameters throughout cli-decode.c, complementing commit fe978cb071b4 ("C++ keyword cleanliness, mostly auto-generated"). =20 Approved-By: Simon Marchi Diff: --- gdb/cli/cli-decode.c | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/gdb/cli/cli-decode.c b/gdb/cli/cli-decode.c index a09a2a09a1e..359ed48b748 100644 --- a/gdb/cli/cli-decode.c +++ b/gdb/cli/cli-decode.c @@ -161,7 +161,7 @@ cmd_list_element::command_components () const =20 /* Add element named NAME. Space for NAME and DOC must be allocated by the caller. - CLASS is the top level category into which commands are broken down + THECLASS is the top level category into which commands are broken down for "help" purposes. FUN should be the function to execute the command; it will get a character string as argument, with leading @@ -494,7 +494,7 @@ empty_func (const char *args, int from_tty, cmd_list_el= ement *c) /* Add element named NAME to command list LIST (the list for set/show or some sublist thereof). TYPE is set_cmd or show_cmd. - CLASS is as in add_cmd. + 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. SET_SETTING_FUNC is a pointer to an optional function callback used to = set @@ -525,7 +525,7 @@ add_set_or_show_cmd (const char *name, } =20 /* Add element named NAME to both the command SET_LIST and SHOW_LIST. - CLASS is as in add_cmd. VAR_TYPE is the kind of thing we are + 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_FUN= C are @@ -610,7 +610,7 @@ add_setshow_cmd_full (const char *name, } =20 /* Add element named NAME to command list LIST (the list for set or - some sublist thereof). CLASS is as in add_cmd. ENUMLIST is a list + some sublist thereof). THECLASS is as in add_cmd. ENUMLIST is a list of strings which may follow NAME. VAR is address of the variable which will contain the matching string (from ENUMLIST). */ =20 @@ -674,7 +674,7 @@ add_setshow_enum_cmd (const char *name, command_class t= heclass, const char * const auto_boolean_enums[] =3D { "on", "off", "auto", NULL }; =20 /* Add an auto-boolean command named NAME to both the set and show - command list lists. CLASS is as in add_cmd. VAR is address of the + command list lists. THECLASS is as in add_cmd. VAR is address of the variable which will contain the value. DOC is the documentation string. FUNC is the corresponding callback. */ =20 @@ -730,7 +730,7 @@ add_setshow_auto_boolean_cmd (const char *name, command= _class theclass, const char * const boolean_enums[] =3D { "on", "off", NULL }; =20 /* Add element named NAME to both the set and show command LISTs (the - list for set/show or some sublist thereof). CLASS is as in + list for set/show or some sublist thereof). THECLASS is as in add_cmd. VAR is address of the variable which will contain the value. SET_DOC and SHOW_DOC are the documentation strings. Returns the new command element. */ @@ -995,7 +995,7 @@ integer_unlimited_completer (struct cmd_list_element *i= gnore, } =20 /* Add element named NAME to both the set and show command LISTs (the - list for set/show or some sublist thereof). CLASS is as in + list for set/show or some sublist thereof). THECLASS is as in add_cmd. VAR is address of the variable which will contain the value. SET_DOC and SHOW_DOC are the documentation strings. This function is only used in Python API. Please don't use it elsewhere. */ @@ -1045,7 +1045,7 @@ add_setshow_integer_cmd (const char *name, command_cl= ass theclass, } =20 /* Add element named NAME to both the set and show command LISTs (the - list for set/show or some sublist thereof). CLASS is as in + list for set/show or some sublist thereof). THECLASS is as in add_cmd. VAR is address of the variable which will contain the value. SET_DOC and SHOW_DOC are the documentation strings. */ =20 @@ -1095,7 +1095,7 @@ add_setshow_uinteger_cmd (const char *name, command_c= lass theclass, } =20 /* Add element named NAME to both the set and show command LISTs (the - list for set/show or some sublist thereof). CLASS is as in + list for set/show or some sublist thereof). THECLASS is as in add_cmd. VAR is address of the variable which will contain the value. SET_DOC and SHOW_DOC are the documentation strings. */ =20 @@ -1182,7 +1182,7 @@ add_setshow_zuinteger_unlimited_cmd (const char *name= , command_class theclass, } =20 /* Add element named NAME to both the set and show command LISTs (the - list for set/show or some sublist thereof). CLASS is as in + list for set/show or some sublist thereof). THECLASS is as in add_cmd. VAR is address of the variable which will contain the value. SET_DOC and SHOW_DOC are the documentation strings. */ =20 @@ -1638,7 +1638,7 @@ help_cmd (const char *command, struct ui_file *stream) * * LIST is the list. * CMDTYPE is the prefix to use in the title string. - * CLASS is the class with which to list the nodes of this list (see + * THECLASS is the class with which to list the nodes of this list (see * documentation for help_cmd_list below), As usual, ALL_COMMANDS for * everything, ALL_CLASSES for just classes, and non-negative for only thi= ngs * in a specific class.