Paths

Table of Contentst

Differential D47015

[llvm-exegesis] Improve documentation.
ClosedPublic
Actions

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

Details

Reviewers

gchatelet
RKSimon
rja

Commits

rG5ec03cdaa3fa: [llvm-exegesis] Improve documentation.
rL332708: [llvm-exegesis] Improve documentation.

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

Harbormaster completed remote builds in B18261: Diff 147318.May 17 2018, 7:44 AM

Herald added a subscriber: tschuett. · View Herald TranscriptMay 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 a subscriber: gbedwell.May 17 2018, 8:02 AM

gbedwell added inline comments.

docs/CommandGuide/llvm-exegesis.rst
173 ↗	(On Diff #147318)	hyphenate non-empty here?

RKSimon added a reviewer: RKSimon.May 17 2018, 8:05 AM

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= ?

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.

Harbormaster completed remote builds in B18263: Diff 147323.May 17 2018, 8:13 AM

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?

s/benchmark-mode/mode/

Harbormaster completed remote builds in B18265: Diff 147327.May 17 2018, 8:27 AM

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.

LG

Closed by commit rL332708: [llvm-exegesis] Improve documentation. (authored by courbet). · Explain WhyMay 18 2018, 5:37 AM

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.

Revision Contents
Changeset List

Path

Size

llvm/

trunk/

docs/

CommandGuide/

llvm-exegesis.rst

140 lines

tools/

llvm-exegesis/

llvm-exegesis.cpp

2 lines

Diff 147484

llvm/trunk/docs/CommandGuide/llvm-exegesis.rst

Loading...

llvm/trunk/tools/llvm-exegesis/llvm-exegesis.cpp

Loading...