[PATCH] D63820: [docs][llvm-objcopy] Write documentation for llvm-objcopy

[Jake Ehrlich via Phabricator via llvm-commits]

jakehehrlich added a comment.

This is *awesome*. This is much more clear and precise that the GNU objcopy documentation!

I hadn't realized just how far the tool has come! Great job!



================
Comment at: docs/CommandGuide/llvm-objcopy.rst:81-82
+
+ For ELF objects, remove all symbols and non-alloc sections not within segments
+ from the output.
+
----------------
We keep .gnu.warning sections as well right?


================
Comment at: docs/CommandGuide/llvm-objcopy.rst:130
+
+.. option:: --only-keep-debug
+
----------------
This is half fair. Technically it meets the requirements for ELF it just doesn't work optimally. I think adding a caveat section under ELF-specific section might be warranted.


================
Comment at: docs/CommandGuide/llvm-objcopy.rst:226
+
+ Remove local symbols starting with ".L" from the output.
+
----------------
Might add "with local binding"


================
Comment at: docs/CommandGuide/llvm-objcopy.rst:379
+
+ Equivalent to specifying :option:`--extract-dwo` with ``<dwo-file>`` as the
+ output file and then :option:`--strip-dwo` on the input file.
----------------
Say "with no other arguments" to clarify that the --extract-dwo file has no flags applied to it.


================
Comment at: docs/CommandGuide/llvm-objcopy.rst:394
+ Remove from the output all section headers and all section data not within
+ segments.
+
----------------
I'd note that many non-llvm tools are incompatible with this option and that it should only be used when a) you need the absolute smallest file possible and b) should never be used on ET_REL binaries.


Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D63820/new/

https://reviews.llvm.org/D63820