summaryrefslogtreecommitdiffstats
path: root/docs/reference/cmdreference/trace
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/cmdreference/trace')
-rw-r--r--docs/reference/cmdreference/trace/index.rst12
-rw-r--r--docs/reference/cmdreference/trace/trace.rst58
2 files changed, 70 insertions, 0 deletions
diff --git a/docs/reference/cmdreference/trace/index.rst b/docs/reference/cmdreference/trace/index.rst
new file mode 100644
index 00000000000..ce213cc985b
--- /dev/null
+++ b/docs/reference/cmdreference/trace/index.rst
@@ -0,0 +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
+
+ trace \ No newline at end of file
diff --git a/docs/reference/cmdreference/trace/trace.rst b/docs/reference/cmdreference/trace/trace.rst
new file mode 100644
index 00000000000..5d0ddb604ef
--- /dev/null
+++ b/docs/reference/cmdreference/trace/trace.rst
@@ -0,0 +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)
+
+**Implementation:** cli_add_trace_buffer \ No newline at end of file