diff options
| author |   Scott Keeler <skeeler@cisco.com> | 2018-10-26 09:12:15 -0400 |
|---|---|---|
| committer |   Damjan Marion <dmarion@me.com> | 2018-10-26 15:35:15 +0000 |
| commit | 6c892301e24a9904841b0969330d6d220b5f83b2 (patch) | |
| tree | f299195fb24940097bb8eaabc1c36d9273caa6ad /docs/reference/cmdreference/trace | |
| parent | eb1119053299c5014a954ed07d10b118ff3ab0d5 (diff) | |
docs: add useful debug CLI Review Updates
Change-Id: I4ebd977672090f2a7fc08bb139832df39614564a
Signed-off-by: Scott Keeler <skeeler@cisco.com>
Diffstat (limited to 'docs/reference/cmdreference/trace')
| -rw-r--r-- | docs/reference/cmdreference/trace/index.rst | 22 | ||||
| -rw-r--r-- | docs/reference/cmdreference/trace/trace.rst | 114 |
2 files changed, 68 insertions, 68 deletions
diff --git a/docs/reference/cmdreference/trace/index.rst b/docs/reference/cmdreference/trace/index.rst index ce213cc985b..1dbbe2e7b3e 100644 --- a/docs/reference/cmdreference/trace/index.rst +++ b/docs/reference/cmdreference/trace/index.rst @@ -1,12 +1,12 @@ -.. _interface: - -.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ . - -Trace Commands -=============== -This section identifies the following types of trace commands: - -.. toctree:: - :maxdepth: 2 - +.. _interface:
+
+.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ .
+
+Trace Commands
+===============
+This section identifies the following types of trace commands:
+
+.. toctree::
+ :maxdepth: 2
+
trace
\ No newline at end of file diff --git a/docs/reference/cmdreference/trace/trace.rst b/docs/reference/cmdreference/trace/trace.rst index 5d0ddb604ef..9d120ed9cab 100644 --- a/docs/reference/cmdreference/trace/trace.rst +++ b/docs/reference/cmdreference/trace/trace.rst @@ -1,58 +1,58 @@ -.. _interface: - -.. toctree:: - -.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ . - - -API Trace -=========== - -Summary/Usage --------------- - -api trace [on|off][first <*n*>][last <*n*>][status][free][post-mortem-on][dump|custom-dump|save|replay <*file*>] - -Description ------------- - -Display, replay, or save a binary API trace. - -Declaration and Implementation -------------------------------- - -**Declaration:** api_trace_command (src/vlibmemory/vlib_api_cli.c line 783) - -**Implementation:** api_trace_command_fn - -Clear Trace -============= - -Summary/Usage --------------- -Clear trace buffer and free memory. -Declaration and implementation - -**Declaration:** clear_trace_cli (src/vlib/trace.c line 519) - -**Implementation:** cli_clear_trace_buffer - -Show Trace -=========== - -`Show Trace <../interface/show.html#show-trace>`_ - -Trace Add -=========== - -Summary/Usage --------------- - -Trace given number of packets. - -Declaration and Implementation -------------------------------- - -**Declaration:** add_trace_cli (src/vlib/trace.c line 405) - +.. _interface:
+
+.. toctree::
+
+.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ .
+
+
+API Trace
+===========
+
+Summary/Usage
+--------------
+
+api trace [on|off][first <*n*>][last <*n*>][status][free][post-mortem-on][dump|custom-dump|save|replay <*file*>]
+
+Description
+------------
+
+Display, replay, or save a binary API trace.
+
+Declaration and Implementation
+-------------------------------
+
+**Declaration:** api_trace_command (src/vlibmemory/vlib_api_cli.c line 783)
+
+**Implementation:** api_trace_command_fn
+
+Clear Trace
+=============
+
+Summary/Usage
+--------------
+Clear trace buffer and free memory.
+Declaration and implementation
+
+**Declaration:** clear_trace_cli (src/vlib/trace.c line 519)
+
+**Implementation:** cli_clear_trace_buffer
+
+Show Trace
+===========
+
+`Show Trace <../show/show.html#show-trace>`_
+
+Trace Add
+===========
+
+Summary/Usage
+--------------
+
+Trace given number of packets.
+
+Declaration and Implementation
+-------------------------------
+
+**Declaration:** add_trace_cli (src/vlib/trace.c line 405)
+
**Implementation:** cli_add_trace_buffer
\ No newline at end of file |