[PATCH] D30842: Add documentation on debug counters to Programmers Manual.

Mehdi AMINI via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Sat Mar 11 21:06:14 PST 2017


mehdi_amini added a comment.

LGTM, but see a few inline comments.



================
Comment at: llvm/trunk/docs/ProgrammersManual.rst:1215
+automatically.  This is where debug counters help.  They provide a framework
+for making parts of your code only execute a certain number of times.
+
----------------
Somehow I feel the word `bisect` should be present in this description, that may help the reader to "connect" quickly to the use case.


================
Comment at: llvm/trunk/docs/ProgrammersManual.rst:1233
+  argument, and the description used in the help is specified by the
+  third argument.
+
----------------
I don't know why this block is indented (I don't write rst every day either). If it is intentional then fine :)


================
Comment at: llvm/trunk/docs/ProgrammersManual.rst:1265
+A utility is provided in `utils/bisect-skip-count` to binary search skip and count arguments. It can be used to automatically minimize
+the skip and count for a debug-counter variable.
+
----------------
The line returns seem a bit funky? (80 cols)


Repository:
  rL LLVM

https://reviews.llvm.org/D30842





More information about the llvm-commits mailing list