X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=blobdiff_plain;f=docs%2Freference%2Fcmdreference%2Ftrace%2Ftrace.rst;h=927342fa3d7d49e0589813ca0dfdce1e8ab3ba2d;hp=9d120ed9cab6958f8c8d99a66254ab76796ef1b6;hb=36217e3ca;hpb=3459ece6da90627b161e2128b5926f1e58e7db65 diff --git a/docs/reference/cmdreference/trace/trace.rst b/docs/reference/cmdreference/trace/trace.rst index 9d120ed9cab..927342fa3d7 100644 --- a/docs/reference/cmdreference/trace/trace.rst +++ b/docs/reference/cmdreference/trace/trace.rst @@ -1,58 +1,59 @@ -.. _interface: - -.. toctree:: - -.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents `_ . - - -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 +.. _interface: + +.. toctree:: + +.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents `_ . + + +API Trace +=========== + +Summary/Usage +-------------- + +api trace [tx][on|off][first ][last ][status][free] + [post-mortem-on][dump|dump-file|dump-json|save|tojson|save-json|replay ][nitems ][initializers ] + +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