maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/CommandGuide/llvm-cxxfilt.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

87 lines
2.1 KiB
ReStructuredText
Raw Normal View History

[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
2019-06-25 18:36:15 +08:00
llvm-cxxfilt - LLVM symbol name demangler
=========================================
[docs][tools] Add missing "program" tags to rst files Sphinx allows for definitions of command-line options using `.. option <name>` and references to those options via `:option:<name>`. However, it looks like there is no scoping of these options by default, meaning that links can end up pointing to incorrect documents. See for example the llvm-mca document, which contains references to -o that, prior to this patch, pointed to a different document. What's worse is that these links appear to be non-deterministic in which one is picked (on my machine, some references end up pointing to opt, whereas on the live docs, they point to llvm-dwarfdump, for example). The fix is to add the .. program <name> tag. This essentially namespaces the options (definitions and references) to the named program, ensuring that the links are kept correct. Reviwed by: andreadb Differential Revision: https://reviews.llvm.org/D63873 llvm-svn: 364538
2019-06-27 21:24:46 +08:00
.. program:: llvm-cxxfilt
[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
2019-06-25 18:36:15 +08:00
SYNOPSIS
--------
:program:`llvm-cxxfilt` [*options*] [*mangled names...*]
DESCRIPTION
-----------
:program:`llvm-cxxfilt` is a symbol demangler that can be used as a replacement
for the GNU :program:`c++filt` tool. It takes a series of symbol names and
prints their demangled form on the standard output stream. If a name cannot be
demangled, it is simply printed as is.
If no names are specified on the command-line, names are read interactively from
the standard input stream. When reading names from standard input, each input
line is split on characters that are not part of valid Itanium name manglings,
i.e. characters that are not alphanumeric, '.', '$', or '_'. Separators between
names are copied to the output as is.
EXAMPLE
-------
.. code-block:: console
$ llvm-cxxfilt _Z3foov _Z3bari not_mangled
foo()
bar(int)
not_mangled
$ cat input.txt
| _Z3foov *** _Z3bari *** not_mangled |
$ llvm-cxxfilt < input.txt
| foo() *** bar(int) *** not_mangled |
OPTIONS
-------
.. option:: --format=<value>, -s
Mangling scheme to assume. Valid values are ``auto`` (default, auto-detect the
style) and ``gnu`` (assume GNU/Itanium style).
.. option:: --help, -h
[docs][llvm-cxxfilt] Fix indentation in rst file This makes it consistent throughout the options, although the end result is unchanged.
2020-04-30 17:40:11 +08:00
Print a summary of command line options.
[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
2019-06-25 18:36:15 +08:00
.. option:: --help-list
[docs][llvm-cxxfilt] Fix indentation in rst file This makes it consistent throughout the options, although the end result is unchanged.
2020-04-30 17:40:11 +08:00
Print an uncategorized summary of command line options.
[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
2019-06-25 18:36:15 +08:00
[docs][llvm-cxxfilt] Document --no-strip-underscore option This option was added several months ago in commit e84468c1. Reviewed by: MaskRay, erik.pilkington, steven_wu Differential Revision: https://reviews.llvm.org/D79166
2020-04-30 17:56:40 +08:00
.. option:: --no-strip-underscore, -n
Do not strip a leading underscore. This is the default for all platforms
except Mach-O based hosts.
[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
2019-06-25 18:36:15 +08:00
.. option:: --strip-underscore, -_
[docs][llvm-cxxfilt] Document --no-strip-underscore option This option was added several months ago in commit e84468c1. Reviewed by: MaskRay, erik.pilkington, steven_wu Differential Revision: https://reviews.llvm.org/D79166
2020-04-30 17:56:40 +08:00
Strip a single leading underscore, if present, from each input name before
demangling. On by default on Mach-O based platforms.
[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
2019-06-25 18:36:15 +08:00
.. option:: --types, -t
Attempt to demangle names as type names as well as function names.
.. option:: --version
[docs] Make --version text more correct Follow-up to r371983. Referring to "this program" in the description of the --version option in the documentation isn't exactly correct, because the docs are not part of the program, and so "this program" doesn't really refer to anything. This patch brings the other users of this terminology into line with the new updates to llvm-size and llvm-strings. Reviewed by: alexshap, MaskRay Differential Revision: https://reviews.llvm.org/D67618 llvm-svn: 372107
2019-09-17 19:43:42 +08:00
Display the version of the :program:`llvm-cxxfilt` executable.
[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
2019-06-25 18:36:15 +08:00
.. option:: @<FILE>
Read command-line options from response file `<FILE>`.
EXIT STATUS
-----------
:program:`llvm-cxxfilt` returns 0 unless it encounters a usage error, in which
case a non-zero exit code is returned.
SEE ALSO
--------
:manpage:`llvm-nm(1)`