Page MenuHomePhabricator

[llvm-exegesis] Improve documentation.
ClosedPublic

Authored by courbet on May 17 2018, 7:44 AM.

Details

Summary
  • Better flag names.
  • Fix flag reference in doc.
  • Add usage examples in doc.

Fixes PR37497.

Diff Detail

Repository
rL LLVM

Event Timeline

courbet created this revision.May 17 2018, 7:44 AM
gchatelet added inline comments.May 17 2018, 7:53 AM
docs/CommandGuide/llvm-exegesis.rst
41 ↗(On Diff #147318)

uops

66 ↗(On Diff #147318)

"Provide an :program:llvm-exegesis option to test all instructions."

152 ↗(On Diff #147318)

benchmark-mode

tools/llvm-exegesis/llvm-exegesis.cpp
52 ↗(On Diff #147318)

remove benchmark

courbet marked 2 inline comments as done.May 17 2018, 7:55 AM
courbet added inline comments.
docs/CommandGuide/llvm-exegesis.rst
152 ↗(On Diff #147318)

not sure what you mean here.

gchatelet accepted this revision.May 17 2018, 7:57 AM
This revision is now accepted and ready to land.May 17 2018, 7:57 AM
gbedwell added inline comments.
docs/CommandGuide/llvm-exegesis.rst
173 ↗(On Diff #147318)

hyphenate non-empty here?

RKSimon added a subscriber: RKSimon.
RKSimon added inline comments.
docs/CommandGuide/llvm-exegesis.rst
70 ↗(On Diff #147318)

include the shebang?

86 ↗(On Diff #147318)

isn't this -benchmark-mode= ?

courbet updated this revision to Diff 147323.May 17 2018, 8:10 AM
courbet marked 3 inline comments as done.

Address review comments.

Thanks.

docs/CommandGuide/llvm-exegesis.rst
86 ↗(On Diff #147318)

I've renamed this to mode (in this very diff) because analysis is not really a benchmark mode.

RKSimon added inline comments.May 17 2018, 8:23 AM
tools/llvm-exegesis/llvm-exegesis.cpp
52 ↗(On Diff #147318)

The option is still "benchmark-mode" - shouldn't this be "mode" now?

courbet updated this revision to Diff 147327.May 17 2018, 8:27 AM
courbet marked an inline comment as done.

s/benchmark-mode/mode/

courbet added inline comments.May 17 2018, 8:28 AM
tools/llvm-exegesis/llvm-exegesis.cpp
52 ↗(On Diff #147318)

Indeed. I must have undone something accidentally. Thanks.

rja accepted this revision.May 17 2018, 1:35 PM
rja added a subscriber: rja.

LG

This revision was automatically updated to reflect the committed changes.

Thanks, do not hesitate if you have more comments on the documentation, I'll integrate them.