[PATCH] D62706: [llvm-lipo] Add docs for llvm-lipo

[Michael Trent via Phabricator via llvm-commits]

mtrent accepted this revision.
mtrent added a comment.
This revision is now accepted and ready to land.

Thanks for making this!



================
Comment at: docs/CommandGuide/llvm-lipo.rst:28
+
+  Verify that the specified architectures are present in the input file.
+
----------------
alexshap wrote:
> mtrent wrote:
> > Verify that the specified architecture is present by doing what? Best to call out the command's exit status here.  
> > 
> > Is it obvious what "architecture" means here? How would you describe that to someone?
> > 
> > The -verify_arch command only works on a single file (the Apple man page suggests otherwise, but AFAICT the code has never supported that). Do you need to mention that here? 
>  >Is it obvious what "architecture" means here?
> no, it's not, honestly, I don't have a good explanation appropriate for docs other than "supported  architecture name" with some popular examples, would you like me to add these bits here ? 
Looks like the major llvm tools (clang, lldb) just refer to "architecture" and leave it at that. llvm-objdump says "see version for available architectures" but the list is weird/incomplete. Let's leave it. 

The opportunity of the man page / CommandGuide is to give some additional context that one can't infer from the command usage / -help. Considering lipo's job, this may be the best place in llvm.org to explain what these things are. All that said, that task isn't urgent, and it can wait for the rest of the functionality to come in. Having this file in place will help with that.


Repository:
  rL LLVM

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

https://reviews.llvm.org/D62706