docs: better docs, mv doxygen to sphinx

[vpp.git] / docs / developer / corefeatures / eventviewer.rst

diff --git a/docs/gettingstarted/developers/eventviewer.rst b/docs/developer/corefeatures/eventviewer.rst
similarity index 97%
rename from docs/gettingstarted/developers/eventviewer.rst
rename to docs/developer/corefeatures/eventviewer.rst
index 59aaef0..21d5fa9 100644 (file)
--- a/docs/gettingstarted/developers/eventviewer.rst
+++ b/docs/developer/corefeatures/eventviewer.rst
@@ -96,7 +96,7 @@ vm->elog\_main. The latter form is correct in the main thread, but
 will almost certainly produce bad results in worker threads.
 
 G2 graphical event viewer
-==========================
+-------------------------
 
 The G2 graphical event viewer can display serialized vppinfra event logs
 directly, or via the c2cpel tool. G2 is a fine-grained event-log viewer. It's
@@ -105,12 +105,12 @@ G2 displays binary data generated by the vppinfra "elog.[ch]" logger component,
 and also supports the CPEL file format, as described in this section.
 
 Building G2
------------
+~~~~~~~~~~~
 
 This link describes :ref:`how to build G2 <building-g2>`
 
 Setting the Display Preferences
-------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The file $<*HOMEDIR*>/.g2 contains display preferences, which can be overridden.
 Simply un-comment one of the stanzas shown below, or experiment as desired.
@@ -142,7 +142,7 @@ Simply un-comment one of the stanzas shown below, or experiment as desired.
      */
 
 Screen Taxonomy
-----------------------------
+~~~~~~~~~~~~~~~
 
 Here is an annotated G2 viewer screenshot, corresponding to activity during BGP
 prefix download. This data was captured on a Cisco IOS-XR system:
@@ -159,7 +159,7 @@ The event selector PolyCheckMenu changes the set of displayed events.
 Using these tools -- and some patience -- you can understand a given event log.
 
 Mouse Gestures
--------------------------
+~~~~~~~~~~~~~~~
 
 G2 has three fairly sophisticated mouse gesture interfaces, which are worth describing
 in detail. First, a left mouse click on a display event pops up a per-event detail box.
@@ -181,7 +181,7 @@ When the zoom operation completes, the display is as follows:
 A click on any of the figures will show them at full resolution, right-click will open figures in new tabs,
 
 Time Ruler
-------------------
+~~~~~~~~~~
 
 To use a time ruler, press and hold the right mouse button; drag right or left
 until the ruler measures the region of interest. If the time axis scale is coarse,
@@ -192,7 +192,7 @@ each event box when using the time ruler.
    :scale: 75%
 
 Event Selection
--------------------------
+~~~~~~~~~~~~~~~
 
 Changing the Event Selector setup controls the set of points displayed in an
 obvious way. Here, we suppress all events except "this thread is now running on the CPU":
@@ -210,7 +210,7 @@ of the event code will reappear when one reselects the event code. In the exampl
 above, the "THREAD/THREADY pid:491720 tid:12" detail box appears in this fashion.
 
 Snapshot Ring
------------------------
+~~~~~~~~~~~~~
 
 Three buttons in lower left-hand corner of the g2 main window control the snapshot
 ring. Snapshots are simply saved views: maneuver the viewer into an "interesting"
@@ -223,7 +223,7 @@ restore the snapshot ring. Eventually we may add a safe/portable/supported mecha
 to save/restore the snapshot ring from CPEL and vppinfra event log files.
 
 Chasing Events
-------------------------
+~~~~~~~~~~~~~~
 
 Event chasing sorts the trace axis by occurrence of the last selected event. For
 example, if one selects an event which means "thread running on the CPU" the first
@@ -241,7 +241,7 @@ After pressing the ChaseEvent button, we see a different picture:
    :scale: 75%
 
 Burying Boring Tracks
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~
 
 The sequence <ctrl><left-mouse-click> moves the track under the mouse to the end
 of the set of tracks, effectively burying it. The sequence <shift><left-mouse-click>
@@ -250,7 +250,7 @@ function probably isn't precisely right--I think we may eventually provide an "u
 stack to provide precise thread exhumation.
 
 Summary Mode
--------------------------
+~~~~~~~~~~~~
 
 Summary mode declutters the screen by rendering events as short vertical line
 segments instead of numbered boxes. Event detail display is unaffected. G2 starts
@@ -260,7 +260,7 @@ tolerable value. Once you've zoomed in sufficiently, type "e" - enter event mode
 to enable boxed numeric event display.
 
 Hotkeys
--------------
+~~~~~~~
 
 G2 supports the following hotkey actions, supposedly (circa 1996) Quake-like
 according to the feature's original author: