docs: add useful debug CLI
[vpp.git] / docs / reference / cmdreference / trace / trace.rst
1 .. _interface:
2
3 .. toctree::
4
5 .. 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>`_ .
6
7
8 API Trace
9 ===========
10
11 Summary/Usage
12 --------------
13
14 api trace [on|off][first <*n*>][last <*n*>][status][free][post-mortem-on][dump|custom-dump|save|replay <*file*>]
15
16 Description
17 ------------
18
19 Display, replay, or save a binary API trace.
20
21 Declaration and Implementation
22 -------------------------------
23
24 **Declaration:** api_trace_command (src/vlibmemory/vlib_api_cli.c line 783)
25
26 **Implementation:** api_trace_command_fn
27
28 Clear Trace
29 =============
30
31 Summary/Usage
32 --------------
33 Clear trace buffer and free memory.
34 Declaration and implementation
35
36 **Declaration:** clear_trace_cli (src/vlib/trace.c line 519)
37
38 **Implementation:** cli_clear_trace_buffer
39
40 Show Trace
41 ===========
42
43 `Show Trace <../interface/show.html#show-trace>`_
44
45 Trace Add
46 ===========
47
48 Summary/Usage
49 --------------
50
51 Trace given number of packets.
52
53 Declaration and Implementation
54 -------------------------------
55
56 **Declaration:** add_trace_cli (src/vlib/trace.c line 405)
57
58 **Implementation:** cli_add_trace_buffer