[llvm] [llvm-cxxfilt] De-emphasize "function" in llvm-cxxfilt docs and --help (PR #113309)
Edd Dawson via llvm-commits
llvm-commits at lists.llvm.org
Tue Oct 22 05:44:40 PDT 2024
https://github.com/playstation-edd created https://github.com/llvm/llvm-project/pull/113309
llvm-cxxfilt can demangle names of data symbols, in addition to function names.
$ llvm-cxxfilt _Z4data
data
And type names too, on request:
$ llvm-cxxfilt -t i
int
Update some overly specific the wording in the --help and documentation that suggests otherwise.
>From fcce0fcc9c760dfa818a0322ca712ac500016a6c Mon Sep 17 00:00:00 2001
From: Edd Dawson <edd.dawson at sony.com>
Date: Tue, 22 Oct 2024 13:06:42 +0100
Subject: [PATCH] [llvm-cxxfilt] De-emphasize "function" in llvm-cxxfilt docs
and --help
llvm-cxxfilt can demangle names of data symbols, in addition to function
names.
$ llvm-cxxfilt _Z4data
data
And type names too, on request:
$ llvm-cxxfilt -t i
int
Update some overly specific the wording in the --help and documentation
that suggests otherwise.
---
llvm/docs/CommandGuide/llvm-cxxfilt.rst | 5 ++---
llvm/tools/llvm-cxxfilt/Opts.td | 4 ++--
2 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/llvm/docs/CommandGuide/llvm-cxxfilt.rst b/llvm/docs/CommandGuide/llvm-cxxfilt.rst
index 6743e361d752a6..8c61cedd9b70ba 100644
--- a/llvm/docs/CommandGuide/llvm-cxxfilt.rst
+++ b/llvm/docs/CommandGuide/llvm-cxxfilt.rst
@@ -59,8 +59,7 @@ OPTIONS
.. option:: --quote
- Add `"` `"` around demangled function symbols. Do not quote already quoted
- symbols.
+ Add `"` `"` around demangled names. Do not quote already quoted names.
.. option:: --strip-underscore, -_
@@ -69,7 +68,7 @@ OPTIONS
.. option:: --types, -t
- Attempt to demangle names as type names as well as function names.
+ Attempt to demangle names as type names as well as symbol names.
.. option:: --version
diff --git a/llvm/tools/llvm-cxxfilt/Opts.td b/llvm/tools/llvm-cxxfilt/Opts.td
index a40bc75354a133..4a997a8f8f5a74 100644
--- a/llvm/tools/llvm-cxxfilt/Opts.td
+++ b/llvm/tools/llvm-cxxfilt/Opts.td
@@ -15,9 +15,9 @@ multiclass Eq<string name, string help> {
}
def help : FF<"help", "Display this help">;
-def quote : FF<"quote", "Quote demangled function names with \" \" if not already quoted">;
+def quote : FF<"quote", "Quote demangled names with \" \" if not already quoted">;
defm strip_underscore : BB<"strip-underscore", "Strip the leading underscore", "Don't strip the leading underscore">;
-def types : FF<"types", "Attempt to demangle types as well as function names">;
+def types : FF<"types", "Attempt to demangle types as well as symbol names">;
def no_params : FF<"no-params", "Skip function parameters and return types">;
def version : FF<"version", "Display the version">;
More information about the llvm-commits
mailing list