This is an archive of the discontinued LLVM Phabricator instance.

Differential D121902

Fix llvm-strip --only-keep-debug documentation for ELF
ClosedPublic

Authored by jhenderson on Mar 17 2022, 4:42 AM.

Details

Reviewers
MaskRay
gbreynoo
alexander-shaposhnikov
Commits
rGc975668ffc30: Fix llvm-strip --only-keep-debug documentation for ELF
Summary

The functionality (and llvm-objcopy's corresponding documentation) was added in https://github.com/llvm/llvm-project/commit/5ad0103d8a04cb066dfae4fc20b0dfcd9413f4d4. It looks like the llvm-strip docs to match were missed.

Diff Detail

Event Timeline

jhenderson created this revision.Mar 17 2022, 4:42 AM
Herald added a reviewer: alexander-shaposhnikov. · View Herald TranscriptMar 17 2022, 4:42 AM
Herald added a project: Restricted Project. · View Herald Transcript
jhenderson requested review of this revision.Mar 17 2022, 4:42 AM
Herald added a project: Restricted Project. · View Herald TranscriptMar 17 2022, 4:42 AM
Harbormaster completed remote builds in B154813: Diff 416135.Mar 17 2022, 5:32 AM
gbreynoo accepted this revision.Mar 17 2022, 8:02 AM

LGTM

This revision is now accepted and ready to land.Mar 17 2022, 8:02 AM
This revision was landed with ongoing or failed builds.Mar 17 2022, 11:50 PM
Closed by commit rGc975668ffc30: Fix llvm-strip --only-keep-debug documentation for ELF (authored by jhenderson). · Explain Why
This revision was automatically updated to reflect the committed changes.
jhenderson added a commit: rGc975668ffc30: Fix llvm-strip --only-keep-debug documentation for ELF.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
21 lines

Diff 416403

llvm/docs/CommandGuide/llvm-strip.rst

Show First 20 Lines • Show All 53 Lines • ▼ Show 20 Lines
Disable :option:`--strip-all`. Disable :option:`--strip-all`.
.. option:: -o <file> .. option:: -o <file>
Write output to <file>. Multiple input files cannot be used in combination Write output to <file>. Multiple input files cannot be used in combination
with -o. with -o.
.. option:: --only-keep-debug
Produce a debug file as the output that only preserves contents of sections
useful for debugging purposes.
For ELF objects, this removes the contents of `SHF_ALLOC` sections that are not
`SHT_NOTE` by making them `SHT_NOBITS` and shrinking the program headers where
possible.
.. option:: --regex .. option:: --regex
If specified, symbol and section names specified by other switches are treated If specified, symbol and section names specified by other switches are treated
as extended POSIX regular expression patterns. as extended POSIX regular expression patterns.
.. option:: --remove-section <section>, -R .. option:: --remove-section <section>, -R
Remove the specified section from the output. Can be specified multiple times Remove the specified section from the output. Can be specified multiple times
▲ Show 20 Lines • Show All 54 Lines • ▼ Show 20 Lines.. option:: --wildcard, -w
The order of wildcards does not matter. For example, ``-w -N '*' -N '!x'`` is The order of wildcards does not matter. For example, ``-w -N '*' -N '!x'`` is
the same as ``-w -N '!x' -N '*'``. the same as ``-w -N '!x' -N '*'``.
.. option:: @<FILE> .. option:: @<FILE>
Read command-line options and commands from response file `<FILE>`. Read command-line options and commands from response file `<FILE>`.
COFF-SPECIFIC OPTIONS
---------------------
The following options are implemented only for COFF objects. If used with other
objects, :program:`llvm-strip` will either emit an error or silently ignore
them.
.. option:: --only-keep-debug
Remove the contents of non-debug sections from the output, but keep the section
headers.
ELF-SPECIFIC OPTIONS ELF-SPECIFIC OPTIONS
-------------------- --------------------
The following options are implemented only for ELF objects. If used with other The following options are implemented only for ELF objects. If used with other
objects, :program:`llvm-strip` will either emit an error or silently ignore objects, :program:`llvm-strip` will either emit an error or silently ignore
them. them.
.. option:: --allow-broken-links .. option:: --allow-broken-links
▲ Show 20 Lines • Show All 51 Lines • Show Last 20 Lines