aboutsummaryrefslogtreecommitdiffstats
path: root/docs/developer/build-run-debug/running_vpp.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/developer/build-run-debug/running_vpp.rst')
-rw-r--r--docs/developer/build-run-debug/running_vpp.rst56
1 files changed, 56 insertions, 0 deletions
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..2c9725727da
--- /dev/null
+++ b/docs/developer/build-run-debug/running_vpp.rst
@@ -0,0 +1,56 @@
+.. _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.
+
+Before running either command, please make sure that the 'gdb' package is installed.
+If it's not installed, run the following command first:
+
+.. code-block:: console
+
+ $ sudo apt install gdb
+
+Running the release image:
+
+.. code-block:: console
+
+ # make debug-release
+ (gdb)
+
+Running the debug image:
+
+.. code-block:: console
+
+ # make debug
+ (gdb)
+