[llvm] r337225 - [llvm-mca][docs] Add notes about cycle and resource callbacks. NFC.

[Matt Davis via llvm-commits]

Author: mattd
Date: Mon Jul 16 16:50:53 2018
New Revision: 337225

URL: http://llvm.org/viewvc/llvm-project?rev=337225&view=rev
Log:
[llvm-mca][docs] Add notes about cycle and resource callbacks. NFC.

Modified:
    llvm/trunk/docs/CommandGuide/llvm-mca.rst

Modified: llvm/trunk/docs/CommandGuide/llvm-mca.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-mca.rst?rev=337225&r1=337224&r2=337225&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-mca.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-mca.rst Mon Jul 16 16:50:53 2018
@@ -273,6 +273,14 @@ describes the state of an instruction (e
 etc.).  The latter describes a stall hazard (e.g., load stall, store stall,
 scheduler stall, etc.).
 
+In addition to the instruction and stall events.  A listener can also
+subscribe to cycle events (``onCycleStart``, ``onCycleEnd``).  These events
+occur before and after a simulated clock cycle is executed, respectively.
+
+Listeners can also be notified of various resource states within the stages
+of a pipeline, such as resource availability, reservation, and reclaim:
+(``onResourceAvailability``, ``onReservedBuffers``, ``onReleasedBuffers``).
+
 Creating a Custom View
 """"""""""""""""""""""
 To create a  custom view, the user must first inherit from the ``View`` class