This is an archive of the discontinued LLVM Phabricator instance.

[docs][llvm-strip] Fix documentation for -s/-S
ClosedPublic

Authored by alexander-shaposhnikov on Jun 24 2021, 5:11 PM.

Download Raw Diff

Details

Reviewers

smeenai
jhenderson

Commits

rGd8678246fcd9: [docs][llvm-strip] Fix documentation for -s/-S

Summary

Fix the command line guide for -g/-s/-S.
In particular, previously it was incorrectly stating that -S is an alias for --strip-all.

Diff Detail

Repository: rG LLVM Github Monorepo

Event Timeline

alexander-shaposhnikov requested review of this revision.Jun 24 2021, 5:11 PM

alexander-shaposhnikov created this revision.

Herald added a project: Restricted Project. · View Herald TranscriptJun 24 2021, 5:11 PM

LGTM

This revision is now accepted and ready to land.Jun 24 2021, 5:12 PM

Harbormaster completed remote builds in B110925: Diff 354400.Jun 24 2021, 5:55 PM

LGTM too (why does a single option need three different short aliases??).

Closed by commit rGd8678246fcd9: [docs][llvm-strip] Fix documentation for -s/-S (authored by alexander-shaposhnikov). · Explain WhyJun 26 2021, 9:27 PM

This revision was automatically updated to reflect the committed changes.

alexander-shaposhnikov added a commit: rGd8678246fcd9: [docs][llvm-strip] Fix documentation for -s/-S.

Revision Contents

Path

Size

llvm/

docs/

CommandGuide/

llvm-strip.rst

4 lines

Diff 354725

llvm/docs/CommandGuide/llvm-strip.rst

	Show First 20 Lines • Show All 68 Lines • ▼ Show 20 Lines
	Remove the specified section from the output. Can be specified multiple times			Remove the specified section from the output. Can be specified multiple times
	to remove multiple sections simultaneously.			to remove multiple sections simultaneously.

	.. option:: --strip-all-gnu			.. option:: --strip-all-gnu

	Remove all symbols, debug sections and relocations from the output. This option			Remove all symbols, debug sections and relocations from the output. This option
	is equivalent to GNU :program:`strip`'s ``--strip-all`` switch.			is equivalent to GNU :program:`strip`'s ``--strip-all`` switch.

	.. option:: --strip-all, -S			.. option:: --strip-all, -s

	For ELF objects, remove from the output all symbols and non-alloc sections not			For ELF objects, remove from the output all symbols and non-alloc sections not
	within segments, except for .gnu.warning, .ARM.attribute sections and the			within segments, except for .gnu.warning, .ARM.attribute sections and the
	section name table.			section name table.

	For COFF objects, remove all symbols, debug sections, and relocations from the			For COFF objects, remove all symbols, debug sections, and relocations from the
	output.			output.

	.. option:: --strip-debug, -g			.. option:: --strip-debug, -d, -g, -S

	Remove all debug sections from the output.			Remove all debug sections from the output.

	.. option:: --strip-symbol <symbol>, -N			.. option:: --strip-symbol <symbol>, -N

	Remove all symbols named ``<symbol>`` from the output. Can be specified			Remove all symbols named ``<symbol>`` from the output. Can be specified
	multiple times to remove multiple symbols.			multiple times to remove multiple symbols.

	▲ Show 20 Lines • Show All 108 Lines • Show Last 20 Lines