[PATCH] D63719: [docs][llvm-readobj] Improve llvm-readobj documentation

Peter Smith via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Jun 24 09:14:09 PDT 2019


peter.smith added a comment.

Thanks for doing this, this is a big improvement. One mild suggestion, but no objections from me.



================
Comment at: docs/CommandGuide/llvm-readobj.rst:26
+
+ Equivalent to specifying :option:`--file-headers`, :option:`--program-headers`,
+ :option:`--sections`, :option:`--symbols`, :option:`--relocations`,
----------------
It might be worth being less specific about what --all does due to the likelihood of it getting out of date as new options are added? I suspect that people wanting --all are those that want to dump all output to a text file in order to search interactively rather than need to know exactly what it does in order to parse it. Perhaps something like "Equivalent to adding the major output format options that are relevant to the file format."

I've not a strong opinion here, so feel free to ignore.


Repository:
  rL LLVM

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

https://reviews.llvm.org/D63719





More information about the llvm-commits mailing list