ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add useful debug CLI Review Updates

Browse Source 
Change-Id: I4ebd977672090f2a7fc08bb139832df39614564a
Signed-off-by: Scott Keeler <skeeler@cisco.com>
This commit is contained in:
Scott Keeler
2018-10-26 09:12:15 -04:00
committed by Damjan Marion
parent eb11190532
commit 6c892301e2
12 changed files with 755 additions and 733 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/cmdreference/trace/index.rst
View File

@ -1,12 +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
.. _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

114
docs/reference/cmdreference/trace/trace.rst
View File

@ -1,58 +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)
.. _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 <../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