From 9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160 Mon Sep 17 00:00:00 2001 From: Nathan Skrzypczak Date: Thu, 19 Aug 2021 11:38:06 +0200 Subject: docs: better docs, mv doxygen to sphinx This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak Signed-off-by: Andrew Yourtchenko --- docs/developer/build-run-debug/running_vpp.rst | 48 ++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/developer/build-run-debug/running_vpp.rst (limited to 'docs/developer/build-run-debug/running_vpp.rst') diff --git a/docs/developer/build-run-debug/running_vpp.rst b/docs/developer/build-run-debug/running_vpp.rst new file mode 100644 index 00000000000..9b33e53ec60 --- /dev/null +++ b/docs/developer/build-run-debug/running_vpp.rst @@ -0,0 +1,48 @@ +.. _running_vpp: + +.. toctree:: + +Running VPP +=========== + +After building the VPP binaries, you now have several images built. +These images are useful when you need to run VPP without installing the packages. +For instance if you want to run VPP with GDB. + +Running Without GDB +_________________________ + +To run the VPP images that you've built without GDB, run the following commands: + +Running the release image: + +.. code-block:: console + + # make run-release + # + +Running the debug image: + +.. code-block:: console + + # make run + # + +Running With GDB +_________________________ + +With the following commands you can run VPP and then be dropped into the GDB prompt. + +Running the release image: + +.. code-block:: console + + # make debug-release + (gdb) + +Running the debug image: + +.. code-block:: console + + # make debug + (gdb) -- cgit 1.2.3-korg