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