[llvm-cxxfilt] De-emphasize "function" in llvm-cxxfilt docs and --help #113309
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/pr-subscribers-llvm-binary-utilities Author: Edd Dawson (playstation-edd) Changesllvm-cxxfilt can demangle names of data symbols, in addition to function names. And type names too, on request: Update some overly specific the wording in the --help and documentation that suggests otherwise. Full diff: https://github.com/llvm/llvm-project/pull/113309.diff 2 Files Affected:
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">;
|
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/73/builds/7457 Here is the relevant piece of the build log for the reference |
Closed
NoumanAmir657
pushed a commit
to NoumanAmir657/llvm-project
that referenced
this pull request
Nov 4, 2024
llvm#113309) llvm-cxxfilt can demangle names of data symbols, in addition to function names. $ llvm-cxxfilt _ZN6garden5gnomeE garden::gnome 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
llvm-cxxfilt can demangle names of data symbols, in addition to function names.
And type names too, on request:
Update some overly specific the wording in the --help and documentation that suggests otherwise.