From patchwork Thu Nov 24 11:21:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Maciej W. Rozycki" X-Patchwork-Id: 61070 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id BA11A38425B3 for ; Thu, 24 Nov 2022 11:22:10 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-wm1-x329.google.com (mail-wm1-x329.google.com [IPv6:2a00:1450:4864:20::329]) by sourceware.org (Postfix) with ESMTPS id 6334D38418A5 for ; Thu, 24 Nov 2022 11:21:55 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 6334D38418A5 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=embecosm.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=embecosm.com Received: by mail-wm1-x329.google.com with SMTP id v7so1095926wmn.0 for ; Thu, 24 Nov 2022 03:21:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=embecosm.com; s=google; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=y9bQxw9bamBHJqGvf6QE9o9x0XWwQobDrT1pZTcfCWw=; b=CYiES5hJl00VNbxzfVzLM75OcjnUWauXSOonYEaSRaFbVj0YswufkUPsXnlKSQNmxE ma9ohKcYtXSCUsjVrr/g4t3lG5XkQ9R0n+NQqlzZQqW0UgZPmewzDzHUDE6DBIUNB+Tw fMxftq/Ct93JVDqMu7wRTmSFGNfuUgo5Tvkoc9U+7/688oc3SqVd+FVu3BUb4YQvOeho ri6L+bSGFiC5hTdf/d0RpWxmi5IXwxwjpyBI471NcFzVMtrTWJKJjCgLUeQWZHhEwBOL ZHHpSuHUg1n3NgHskO8YS0Vn9qrY03CCGpoG7hHumTDmI5EB+hZp5v8PENyXCzb8lnd3 zgAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:references:message-id:in-reply-to:subject :cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=y9bQxw9bamBHJqGvf6QE9o9x0XWwQobDrT1pZTcfCWw=; b=a55F8gYr6sQJIfS0ARghwNIHSiI5jgp4n1CBkLyEQL4+ZnUzC1VUMTgRICHhTbNILr 5xaHgEjBWTVPjnjPr+rkCh9hed6mR4SkBDI3LpCgyCxp+sH5GrjzQfvt2oRz6Asg5BBG qJWtFq4de7zruYrW2ZR/32WBQJHflHoSCIiZAqMK2bFkgvet2ven4G4fZS/87uZy0Sjv jMHfd7P+chsCMc/LhsRDoD+HohjBZQwGyfCdYuPTUvZSEW/2xXJ7aBlCBal4bFoJ94Ck zAh/VlIQK35vU0yLAYUS/41C9gitepCmxEzmonkM3Zc8Iw5B7wa7RP+YFgZrKDmJeMJK hY8Q== X-Gm-Message-State: ANoB5pk6enTChXgQFv6Yh/QB3ZPTpTgRjI6Hy8LTldAfa49Y3+wWJApG ej6avJ/+Zhsm59K04IePVN2TogFg3HAdugsc X-Google-Smtp-Source: AA0mqf7986Bbm4TPteZkj0oNifwCK3cd+sTC91qSw641ZqVEYv80o3xFslaiCpQfOPQr7XvtI2W7rg== X-Received: by 2002:a1c:f712:0:b0:3cc:a9be:d9e9 with SMTP id v18-20020a1cf712000000b003cca9bed9e9mr22697657wmh.173.1669288914123; Thu, 24 Nov 2022 03:21:54 -0800 (PST) Received: from tpp.orcam.me.uk (tpp.orcam.me.uk. [2001:8b0:154:0:ea6a:64ff:fe24:f2fc]) by smtp.gmail.com with ESMTPSA id m29-20020a05600c3b1d00b003c6b7f5567csm11235669wms.0.2022.11.24.03.21.53 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 24 Nov 2022 03:21:53 -0800 (PST) Date: Thu, 24 Nov 2022 11:21:52 +0000 (GMT) From: "Maciej W. Rozycki" To: gdb-patches@sourceware.org cc: Andrew Burgess , Simon Marchi , Tom Tromey , Simon Sobisch Subject: [PATCH v8 1/6] GDB: Fix documentation for `theclass' parameters in cli-decode.c In-Reply-To: Message-ID: References: User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 X-Spam-Status: No, score=-2.5 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Rename CLASS to THECLASS in the documentation for `theclass' parameters throughout cli-decode.c, complementing commit fe978cb071b4 ("C++ keyword cleanliness, mostly auto-generated"). --- New change in v8. --- gdb/cli/cli-decode.c | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) gdb-cli-decode-doc-theclass.diff Index: src/gdb/cli/cli-decode.c =================================================================== --- src.orig/gdb/cli/cli-decode.c +++ src/gdb/cli/cli-decode.c @@ -161,7 +161,7 @@ cmd_list_element::command_components () /* 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_t /* 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, } /* 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_FUNC are @@ -610,7 +610,7 @@ add_setshow_cmd_full (const char *name, } /* 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). */ @@ -674,7 +674,7 @@ add_setshow_enum_cmd (const char *name, const char * const auto_boolean_enums[] = { "on", "off", "auto", NULL }; /* 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. */ @@ -730,7 +730,7 @@ add_setshow_auto_boolean_cmd (const char const char * const boolean_enums[] = { "on", "off", NULL }; /* 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_ } /* 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 *nam } /* 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. */ @@ -1095,7 +1095,7 @@ add_setshow_uinteger_cmd (const char *na } /* 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. */ @@ -1182,7 +1182,7 @@ add_setshow_zuinteger_unlimited_cmd (con } /* 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. */ @@ -1638,7 +1638,7 @@ help_cmd (const char *command, struct ui * * 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 things * in a specific class.