[PATCH] D68998: [docs][llvm-ar] Update llvm-ar command guide

Owen Reynolds via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Oct 16 09:04:37 PDT 2019


gbreynoo marked 2 inline comments as done.
gbreynoo added inline comments.


================
Comment at: llvm/docs/CommandGuide/llvm-ar.rst:55
+
+Long Options
+~~~~~~~~~~~~
----------------
ruiu wrote:
> I see why you named this section "Long Options", but the section that would have been named "short options" is actually named "operations", and this section contains short options such as `-h`, so this section name seems a bit odd to me.
I think the distinction between "Operation", "Modifier" and "Other" is helpful to the user but I'm not sure what to call this "Other" section. "Non key letter" feels long winded, and `-h` doesn't  fit that either. 

Maybe it should be called "Other" and put underneath the other two sections. `M` and `h` could be moved to the "Operation" section and `--help` would be considered a synonym. What do you think?


================
Comment at: llvm/docs/CommandGuide/llvm-ar.rst:324
 
-ar(1)
+:manpage:`ar(1)`
----------------
rupprecht wrote:
> This is a dead link for me - https://llvm.org/docs/CommandGuide/ar.html
This was a carry over from the current guide. Should a link to the gnu-ar command guide be put here instead or would it be best to remove the section all together? 


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

https://reviews.llvm.org/D68998





More information about the llvm-commits mailing list