[PATCH] D63606: [docs][llvm-objdump] Improve llvm-objdump documentation

Fangrui Song via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Fri Jun 21 00:52:01 PDT 2019


MaskRay added a subscriber: emaste.
MaskRay added a comment.

In D63606#1553126 <https://reviews.llvm.org/D63606#1553126>, @mtrent wrote:

> In D63606#1553087 <https://reviews.llvm.org/D63606#1553087>, @MaskRay wrote:
>
> > BTW, there is a manpage: `llvm/docs/llvm-objdump.1`. It'd be nice to check if it needs updates as well.
>
>
> Do we know why there is a separate llvm-objdump.1 instead of just generating the man page from the rst file with Sphinx? Seems unfortunate to maintain two files with the same logical contents ...


It was added in D54864 <https://reviews.llvm.org/D54864> by @emaste. Also see https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=233437 
Do you know how good rst is to generate the man page? If it is less ideal (mdoc is a complex format...), personally I think it is fine to stick with the current manually maintained manpage...

Many people prefer `man llvm-objdump` to an online document...


Repository:
  rL LLVM

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

https://reviews.llvm.org/D63606





More information about the llvm-commits mailing list