This is an archive of the discontinued LLVM Phabricator instance.

Differential D97662

[llvm-objcopy][llvm-strip] Improve --discard-all documentation and help
ClosedPublic

Authored by jhenderson on Mar 1 2021, 1:07 AM.

Details

Reviewers
MaskRay
rupprecht
grimar
alexander-shaposhnikov
Commits
rGf2e85c3101e3: [llvm-objcopy][llvm-strip] Improve --discard-all documentation and help
Summary

The help text and documentation for the --discard-all option failed to mention that the option also causes the removal of debug sections. This change fixes both for both llvm-objcopy and llvm-strip.

Diff Detail

Event Timeline

jhenderson created this revision.Mar 1 2021, 1:07 AM
Herald added a subscriber: abrachet. · View Herald TranscriptMar 1 2021, 1:07 AM
jhenderson requested review of this revision.Mar 1 2021, 1:07 AM
Herald added a project: Restricted Project. · View Herald TranscriptMar 1 2021, 1:07 AM
Harbormaster completed remote builds in B91288: Diff 327043.Mar 1 2021, 1:55 AM
MaskRay accepted this revision.Mar 1 2021, 12:44 PM

Looks great!

This revision is now accepted and ready to land.Mar 1 2021, 12:44 PM
This revision was landed with ongoing or failed builds.Mar 4 2021, 2:33 AM
Closed by commit rGf2e85c3101e3: [llvm-objcopy][llvm-strip] Improve --discard-all documentation and help (authored by jhenderson). · Explain Why
This revision was automatically updated to reflect the committed changes.
jhenderson added a commit: rGf2e85c3101e3: [llvm-objcopy][llvm-strip] Improve --discard-all documentation and help.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
2 lines
2 lines
tools/
llvm-objcopy/
3 lines

Diff 328091

llvm/docs/CommandGuide/llvm-objcopy.rst

Show First 20 Lines • Show All 53 Lines • ▼ Show 20 Lines
Use real values for UIDs, GIDs and timestamps when updating archive member Use real values for UIDs, GIDs and timestamps when updating archive member
headers. headers.
.. option:: --discard-all, -x .. option:: --discard-all, -x
Remove most local symbols from the output. Different file formats may limit Remove most local symbols from the output. Different file formats may limit
this to a subset of the local symbols. For example, file and section symbols in this to a subset of the local symbols. For example, file and section symbols in
ELF objects will not be discarded. ELF objects will not be discarded. Additionally, remove all debug sections.
.. option:: --dump-section <section>=<file> .. option:: --dump-section <section>=<file>
Dump the contents of section ``<section>`` into the file ``<file>``. Can be Dump the contents of section ``<section>`` into the file ``<file>``. Can be
specified multiple times to dump multiple sections to different files. specified multiple times to dump multiple sections to different files.
``<file>`` is unrelated to the input and output files provided to ``<file>`` is unrelated to the input and output files provided to
:program:`llvm-objcopy` and as such the normal copying and editing :program:`llvm-objcopy` and as such the normal copying and editing
operations will still be performed. No operations are performed on the sections operations will still be performed. No operations are performed on the sections
▲ Show 20 Lines • Show All 472 Lines • Show Last 20 Lines

llvm/docs/CommandGuide/llvm-strip.rst

Show All 33 Lines
Use real values for UIDs, GIDs and timestamps when updating archive member Use real values for UIDs, GIDs and timestamps when updating archive member
headers. headers.
.. option:: --discard-all, -x .. option:: --discard-all, -x
Remove most local symbols from the output. Different file formats may limit Remove most local symbols from the output. Different file formats may limit
this to a subset of the local symbols. For example, file and section symbols in this to a subset of the local symbols. For example, file and section symbols in
ELF objects will not be discarded. ELF objects will not be discarded. Additionally, remove all debug sections.
.. option:: --enable-deterministic-archives, -D .. option:: --enable-deterministic-archives, -D
Enable deterministic mode when stripping archives, i.e. use 0 for archive member Enable deterministic mode when stripping archives, i.e. use 0 for archive member
header UIDs, GIDs and timestamp fields. On by default. header UIDs, GIDs and timestamp fields. On by default.
.. option:: --help, -h .. option:: --help, -h
▲ Show 20 Lines • Show All 152 Lines • Show Last 20 Lines

llvm/tools/llvm-objcopy/CommonOpts.td

Show First 20 Lines • Show All 93 Lines • ▼ Show 20 Linesdef discard_locals : Flag<["--"], "discard-locals">,
HelpText<"Remove compiler-generated local symbols, (e.g. " HelpText<"Remove compiler-generated local symbols, (e.g. "
"symbols starting with .L)">; "symbols starting with .L)">;
def X : Flag<["-"], "X">, def X : Flag<["-"], "X">,
Alias<discard_locals>, Alias<discard_locals>,
HelpText<"Alias for --discard-locals">; HelpText<"Alias for --discard-locals">;
def discard_all def discard_all
: Flag<["--"], "discard-all">, : Flag<["--"], "discard-all">,
HelpText<"Remove all local symbols except file and section symbols">; HelpText<"Remove all local symbols except file and section symbols. Also "
"remove all debug sections">;
def x : Flag<["-"], "x">, def x : Flag<["-"], "x">,
Alias<discard_all>, Alias<discard_all>,
HelpText<"Alias for --discard-all">; HelpText<"Alias for --discard-all">;
def regex def regex
: Flag<["--"], "regex">, : Flag<["--"], "regex">,
HelpText<"Permit regular expressions in name comparison">; HelpText<"Permit regular expressions in name comparison">;
Show All 15 Lines