api: API trace improvements

[vpp.git] / docs / reference / cmdreference / trace / trace.rst

diff --git a/docs/reference/cmdreference/trace/trace.rst b/docs/reference/cmdreference/trace/trace.rst
index 9d120ed..927342f 100644 (file)
--- a/docs/reference/cmdreference/trace/trace.rst
+++ b/docs/reference/cmdreference/trace/trace.rst
@@ -1,58 +1,59 @@
-.. _interface:\r
-\r
-.. toctree::\r
-\r
-.. 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>`_ .\r
-\r
-\r
-API Trace \r
-===========\r
-\r
-Summary/Usage\r
---------------\r
-\r
-api trace [on|off][first <*n*>][last <*n*>][status][free][post-mortem-on][dump|custom-dump|save|replay <*file*>]\r
-\r
-Description\r
-------------\r
-\r
-Display, replay, or save a binary API trace.\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** api_trace_command (src/vlibmemory/vlib_api_cli.c line 783)\r
-\r
-**Implementation:** api_trace_command_fn\r
-\r
-Clear Trace\r
-=============\r
-\r
-Summary/Usage\r
---------------\r
-Clear trace buffer and free memory.\r
-Declaration and implementation\r
-\r
-**Declaration:** clear_trace_cli (src/vlib/trace.c line 519)\r
-\r
-**Implementation:** cli_clear_trace_buffer\r
-\r
-Show Trace\r
-===========\r
-\r
-`Show Trace <../show/show.html#show-trace>`_\r
-\r
-Trace Add\r
-===========\r
-\r
-Summary/Usage\r
---------------\r
-\r
-Trace given number of packets.\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** add_trace_cli (src/vlib/trace.c line 405)\r
-\r
-**Implementation:** cli_add_trace_buffer
\ No newline at end of file
+.. _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 [tx][on|off][first <n>][last <n>][status][free]
+       [post-mortem-on][dump|dump-file|dump-json|save|tojson|save-json|replay <file>][nitems <n>][initializers <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