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

docs: mention how to build VPP outside git

Browse Source 
Type: docs

Change-Id: Iceee9ef489f7f68049882651bb338311295ca12d
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
This commit is contained in:
Vratko Polak
2023-09-13 10:22:57 +02:00
committed by Dave Wallace
parent e462e543b2
commit c142cd115b
3 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/developer/build-run-debug/building.rst
View File

@ -116,6 +116,22 @@ To get the VPP sources that are used to create the build, run the following comm
$ git clone https://gerrit.fd.io/r/vpp
$ cd vpp
As VPP version is derived from git description (which is based on git tags),
if the github generated tarballs are used, the version information
will be missing from the version file (.../src/scripts/.version)
which is required by the version script when building
in a non-git based workspace or the build will fail.
In that case, put the desired version string into
.../src/scripts/.version to satisfy the requirements of the version script.
Alternatively, the ``make dist`` command in a cloned git workspace
will generate an xz compressed tarball of the source
including the .../src/scripts/.version file containing the git hash
using the standard nomenclature for VPP images.
Extract the tarball using the -J option to decompress it using xz. For example,
``tar xvJf ./build-root/vpp-23.10-rc0~184-g48cd559fb.tar.xz``
Build VPP Dependencies
--------------------------------------

7
docs/gettingstarted/troubleshooting/sanitizer.rst
View File

@ -14,8 +14,11 @@ AddressSanitizer
`AddressSanitizer <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (aka ASan) is a memory
error detector for C/C++. Think Valgrind but much faster.
In order to use it, VPP must be recompiled with ASan support. It is implemented as a cmake
build option, so all VPP targets should be supported. For example:
In order to use it, VPP must be recompiled with ASan support.
See developer documentation on prerequisites for :ref:`building VPP <building>`.
ASan support is implemented as a cmake build option,
so all VPP targets should be supported. For example:
.. code-block:: console

1
docs/spelling_wordlist.txt
View File

@ -1352,6 +1352,7 @@ XXhash
xxx
XXX
xyz
xz
yaml
Yaml
YYMM