[llvm] r372864 - [docs][llvm-strip] Update llvm-strip doc to better match llvm-objcopy's

[James Henderson via llvm-commits]

Author: jhenderson
Date: Wed Sep 25 06:09:12 2019
New Revision: 372864

URL: http://llvm.org/viewvc/llvm-project?rev=372864&view=rev
Log:
[docs][llvm-strip] Update llvm-strip doc to better match llvm-objcopy's

Main changes are mostly wording of some options, but this change also
fixes a switch reference so that a link is created and moves
--strip-sections into the ELF-specific area since it is only supported
for ELF currently.

Modified:
    llvm/trunk/docs/CommandGuide/llvm-strip.rst

Modified: llvm/trunk/docs/CommandGuide/llvm-strip.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-strip.rst?rev=372864&r1=372863&r2=372864&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-strip.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-strip.rst Wed Sep 25 06:09:12 2019
@@ -52,7 +52,7 @@ multiple file formats.
 
 .. option::  --no-strip-all
 
- Disable --strip-all.
+ Disable :option:`--strip-all`.
 
 .. option::  -o <file>
 
@@ -84,11 +84,7 @@ multiple file formats.
 
 .. option:: --strip-debug, -g
 
- Remove all debug sections.
-
-.. option:: --strip-sections
-
- Remove all section headers and all sections not in segments.
+ Remove all debug sections from the output.
 
 .. option:: --strip-symbol <symbol>, -N
 
@@ -147,12 +143,18 @@ them.
 
 .. option:: --keep-symbol <symbol>, -K
 
- Do not remove symbols named ``<symbol>``. Can be specified multiple times to
- keep multiple symbols.
+ When removing symbols from the output, do not remove symbols named
+ ``<symbol>``. Can be specified multiple times to keep multiple symbols.
 
 .. option::  --preserve-dates, -p
 
- Preserve access and modification timestamps.
+ Preserve access and modification timestamps in the output.
+
+.. option:: --strip-sections
+
+ Remove from the output all section headers and all section data not within
+ segments. Note that many tools will not be able to use an object without
+ section headers.
 
 EXIT STATUS
 -----------