This is an archive of the discontinued LLVM Phabricator instance.

[llvm-lipo] Update llvm-lipo docs for -archs flag
ClosedPublic

Authored by anushabasana on Jun 10 2019, 3:22 PM.

Diff Detail

Repository
rL LLVM

Event Timeline

anushabasana created this revision.Jun 10 2019, 3:22 PM

I've added one inline comment, other than that - LGTM, I'd wait for @mtrent as well )

llvm/docs/CommandGuide/llvm-lipo.rst
32 ↗(On Diff #203909)

maybe add a bit more details similar to what the man page says:
"Each architecture name is a single word, making this option
suitable for shell scripting. Unknown architectures will be represented by "unknown" along with the numeric CPU type and CPU subtype values as a single word.", though personally I don't insist.

This revision is now accepted and ready to land.Jun 10 2019, 3:37 PM

Added more detail

anushabasana marked an inline comment as done.Jun 10 2019, 4:03 PM
mtrent accepted this revision.Jun 10 2019, 10:16 PM

approving this revision in light of my notes inline. I still believe this command guide is going to need an editorial pass once all of the options are in. my main concern for the moment is that the information is accurate and complete.

llvm/docs/CommandGuide/llvm-lipo.rst
34 ↗(On Diff #203925)

Hmmmm .... I'm going to provide this feedback so I'm not repeating the contents of the Apple man page, which may be under copyright.

The main idea here is:

  1. archs takes a single input file
  2. each arch is printed by itself separated by whitespace. (It so happens that arches are also single words, but that's kind of obvious.)

These two facts taken together means that -archs is well suited for shell scripting, where can do something like "foreach i (llvm-lipo -archs <file>)"

My problem with the content here is that " Print architectures as a single word so -archs is suitable for shell scripting." is clumsy and doesn't quite make sense. Easiest edit might just be to say:

"Take a single input file and display the architectures present in the file. Each architecture is separated only by whitespace. Unknown architectures are displayed as unknown(CPUtype,CPUsubtype)."

and let the chips fall where they may.

anushabasana marked an inline comment as done.Jun 11 2019, 9:37 AM

Clarified description.

I'll go ahead and commit this since all comments have been addressed.

This revision was automatically updated to reflect the committed changes.