Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Tom Tromey <tromey@adacore.com>
To: gdb-patches@sourceware.org
Cc: Tom Tromey <tromey@adacore.com>
Subject: [PATCH 1/2] Use upper case for "metasyntactic variables"
Date: Mon, 26 Jan 2026 08:32:45 -0700	[thread overview]
Message-ID: <20260126-metasyntactic-v1-1-02e22dbe6c2b@adacore.com> (raw)
In-Reply-To: <20260126-metasyntactic-v1-0-02e22dbe6c2b@adacore.com>

GNU typically uses all upper-case to refer to user-supplied text, as
opposed to the other common convention of angle brackets.

This patch fixes the cases of the latter that I found in help and
error text.
---
 gdb/cli/cli-cmds.c |  4 ++--
 gdb/printcmd.c     | 34 +++++++++++++++++-----------------
 2 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/gdb/cli/cli-cmds.c b/gdb/cli/cli-cmds.c
index a37e38e9709..6fa5a61ae02 100644
--- a/gdb/cli/cli-cmds.c
+++ b/gdb/cli/cli-cmds.c
@@ -2667,8 +2667,8 @@ INIT_GDB_FILE (cli_cmds)
   add_cmd ("essential", class_essential, _("\
 GDB essential commands.\n\
 Welcome to GDB!  This help text aims to provide a quickstart explanation\n\
-that will allow you to start using GDB.  Feel free to use \"help <cmd>\"\n\
-to get further explanations for any command <cmd>, and check the online\n\
+that will allow you to start using GDB.  Feel free to use \"help CMD\"\n\
+to get further explanations for any command CMD, and check the online\n\
 documentation for in-depth explanations.\n\
 Here are some common GDB behaviors that you can expect, which are\n\
 not tied to any specific command but rather GDB functionality itself:\n\
diff --git a/gdb/printcmd.c b/gdb/printcmd.c
index 7c97fc71992..666ed5a8a64 100644
--- a/gdb/printcmd.c
+++ b/gdb/printcmd.c
@@ -3036,7 +3036,7 @@ memory_tag_with_logical_tag_command (const char *args, int from_tty)
     show_memory_tagging_unsupported ();
 
   if (args == nullptr)
-    error_no_arg (_("<address> <tag>"));
+    error_no_arg (_("ADDRESS TAG"));
 
   gdb::byte_vector tags;
   struct value *val;
@@ -3116,7 +3116,7 @@ parse_set_allocation_tag_input (const char *args, struct value **val,
 }
 
 /* Implement the "memory-tag set-allocation-tag" command.
-   ARGS should be in the format <address> <length> <tags>.  */
+   ARGS should be in the format ADDRESS LENGTH TAGS.  */
 
 static void
 memory_tag_set_allocation_tag_command (const char *args, int from_tty)
@@ -3125,7 +3125,7 @@ memory_tag_set_allocation_tag_command (const char *args, int from_tty)
     show_memory_tagging_unsupported ();
 
   if (args == nullptr)
-    error_no_arg (_("<starting address> <length> <tag bytes>"));
+    error_no_arg (_("STARTING-ADDRESS LENGTH TAG-BYTES"));
 
   gdb::byte_vector tags;
   size_t length = 0;
@@ -3399,37 +3399,37 @@ Generic command for printing and manipulating memory tag properties."),
   add_cmd ("print-logical-tag", class_vars,
 	   memory_tag_print_logical_tag_command,
 	   ("Print the logical tag from POINTER.\n\
-Usage: memory-tag print-logical-tag <POINTER>.\n\
-<POINTER> is an expression that evaluates to a pointer.\n\
+Usage: memory-tag print-logical-tag POINTER.\n\
+POINTER is an expression that evaluates to a pointer.\n\
 Print the logical tag contained in POINTER.  The tag interpretation is\n\
 architecture-specific."),
 	   &memory_tag_list);
   add_cmd ("print-allocation-tag", class_vars,
 	   memory_tag_print_allocation_tag_command,
 	   _("Print the allocation tag for ADDRESS.\n\
-Usage: memory-tag print-allocation-tag <ADDRESS>.\n\
-<ADDRESS> is an expression that evaluates to a memory address.\n\
+Usage: memory-tag print-allocation-tag ADDRESS.\n\
+ADDRESS is an expression that evaluates to a memory address.\n\
 Print the allocation tag associated with the memory address ADDRESS.\n\
 The tag interpretation is architecture-specific."),
 	   &memory_tag_list);
   add_cmd ("with-logical-tag", class_vars, memory_tag_with_logical_tag_command,
 	   _("Print a POINTER with a specific logical TAG.\n\
-Usage: memory-tag with-logical-tag <POINTER> <TAG>\n\
-<POINTER> is an expression that evaluates to a pointer.\n\
-<TAG> is a sequence of hex bytes that is interpreted by the architecture\n\
+Usage: memory-tag with-logical-tag POINTER TAG\n\
+POINTER is an expression that evaluates to a pointer.\n\
+TAG is a sequence of hex bytes that is interpreted by the architecture\n\
 as a single memory tag."),
 	   &memory_tag_list);
   add_cmd ("set-allocation-tag", class_vars,
 	   memory_tag_set_allocation_tag_command,
 	   _("Set the allocation tag(s) for a memory range.\n\
-Usage: memory-tag set-allocation-tag <ADDRESS> <LENGTH> <TAG_BYTES>\n\
-<ADDRESS> is an expression that evaluates to a memory address\n\
-<LENGTH> is the number of bytes that is added to <ADDRESS> to calculate\n\
+Usage: memory-tag set-allocation-tag ADDRESS LENGTH TAG-BYTES\n\
+ADDRESS is an expression that evaluates to a memory address\n\
+LENGTH is the number of bytes that is added to ADDRESS to calculate\n\
 the memory range.\n\
-<TAG_BYTES> is a sequence of hex bytes that is interpreted by the\n\
+TAG-BYTES is a sequence of hex bytes that is interpreted by the\n\
 architecture as one or more memory tags.\n\
 Sets the tags of the memory range [ADDRESS, ADDRESS + LENGTH)\n\
-to TAG_BYTES.\n\
+to TAG-BYTES.\n\
 \n\
 If the number of tags is greater than or equal to the number of tag granules\n\
 in the [ADDRESS, ADDRESS + LENGTH) range, only the tags up to the\n\
@@ -3442,8 +3442,8 @@ that gets repeated until the number of tag granules in the memory range\n\
 	   &memory_tag_list);
   add_cmd ("check", class_vars, memory_tag_check_command,
 	   _("Validate a pointer's logical tag against the allocation tag.\n\
-Usage: memory-tag check <POINTER>\n\
-<POINTER> is an expression that evaluates to a pointer\n\
+Usage: memory-tag check POINTER\n\
+POINTER is an expression that evaluates to a pointer\n\
 Fetch the logical and allocation tags for POINTER and compare them\n\
 for equality.  If the tags do not match, print additional information about\n\
 the tag mismatch."),

-- 
2.52.0


  reply	other threads:[~2026-01-26 15:33 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-26 15:32 [PATCH 0/2] Metasyntactic formatting nits Tom Tromey
2026-01-26 15:32 ` Tom Tromey [this message]
2026-01-26 15:32 ` [PATCH 2/2] Regularize spelling of names of keys Tom Tromey
2026-02-02 17:16 ` [PATCH 0/2] Metasyntactic formatting nits Kevin Buettner
2026-02-02 19:28   ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260126-metasyntactic-v1-1-02e22dbe6c2b@adacore.com \
    --to=tromey@adacore.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox