[PATCH] D131518: Make opt-viewer more usable by general developers - part 1/N

[Ofek Shilon via Phabricator via llvm-commits]

OfekShilon updated this revision to Diff 452434.
OfekShilon retitled this revision from "Make opt-viewer more usable by general developers" to "Make opt-viewer more usable by general developers - part 1/N".
OfekShilon added a comment.

@fhahn  You're right of course. I trimmed this patch to include just the added example and the two-line python requirements file.  Hopefully this would be an easy approval and I'll add more gradual patches to be reviewed.

Regarding documentation, 3 directions come to mind: 
(1) Since llvm is on now github, a README.md file can be used. I have a decent starting point ready here <https://github.com/OfekShilon/optview2/blob/main/README.md> (after renaming from "OptView2" of course) and this might be the easiest.
(2) Alternatively, this content can be spilled into ./llvm/docs/Remarks.rst - extending the existing opt-viewer section <https://llvm.org/docs/Remarks.html#opt-viewer>
(3) Finally I can create a separate ./llvm/docs/OptViewer.rst and link to it from Remarks.rst.

This will probably be the last patch I submit anyway. What do you think?


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

https://reviews.llvm.org/D131518

Files:
  llvm/tools/opt-viewer/cpp_optimization_example/.gitignore
  llvm/tools/opt-viewer/cpp_optimization_example/Makefile
  llvm/tools/opt-viewer/cpp_optimization_example/main.cc
  llvm/tools/opt-viewer/cpp_optimization_example/run_optview.sh
  llvm/tools/opt-viewer/requirements.txt

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D131518.452434.patch
Type: text/x-patch
Size: 2897 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220813/751c7a54/attachment.bin>