Page MenuHomePhabricator

[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation
ClosedPublic

Authored by jhenderson on Mon, Jun 24, 9:21 AM.

Details

Summary

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 D63211, this change replaces the existing stub with an RST file.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Mon, Jun 24, 9:21 AM
Herald added a project: Restricted Project. · View Herald TranscriptMon, Jun 24, 9:21 AM
mattd accepted this revision.Mon, Jun 24, 10:28 AM

This looks great! Thanks.

docs/CommandGuide/llvm-cxxfilt.rst
43 ↗(On Diff #206236)

Perhaps I'm being overly pedantic, but Itanium section 5.1.1 mentions that: "Mangled names containing '$' or '.' are reserved for private implementation use" [http://itanium-cxx-abi.github.io/cxx-abi/abi.html]. I do not know if GNU chooses to represent those characters differently; I recall a difference, but it might be more confusing to spell that out in this option description.

70 ↗(On Diff #206236)

nit: "EXIT STATUS" seems to be the more common section name.

This revision is now accepted and ready to land.Mon, Jun 24, 10:28 AM
MaskRay accepted this revision.Mon, Jun 24, 10:31 PM
jhenderson marked an inline comment as done.Tue, Jun 25, 3:25 AM
jhenderson added inline comments.
docs/CommandGuide/llvm-cxxfilt.rst
43 ↗(On Diff #206236)

I don't think it's worth going into that level of pedantry, mainly because only one style is actually supported. I also don't think it's within the scope of the llvm-cxxfilt documentation to explain how names are demangled. (I note for example that ._Z3foov demangles to .foo() for GNU c++filt, but does not demangle for llvm-cxxfilt.

This revision was automatically updated to reflect the committed changes.