diff options
| author |   Vratko Polak <vrpolak@cisco.com> | 2023-09-13 10:22:57 +0200 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2023-09-13 13:37:22 +0000 |
| commit | c142cd115b6e5c95faffd7735fbee835c8538089 (patch) | |
| tree | 7e50a5c2281e3cf26537864796d523d93f2b6f0a /docs/developer/build-run-debug/building.rst | |
| parent | e462e543b2c672ec6869a9d3653605ea7084d565 (diff) | |
docs: mention how to build VPP outside git
Type: docs
Change-Id: Iceee9ef489f7f68049882651bb338311295ca12d
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'docs/developer/build-run-debug/building.rst')
| -rw-r--r-- | docs/developer/build-run-debug/building.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/developer/build-run-debug/building.rst b/docs/developer/build-run-debug/building.rst index ca7fdef0222..9e9e79db376 100644 --- a/docs/developer/build-run-debug/building.rst +++ b/docs/developer/build-run-debug/building.rst @@ -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 -------------------------------------- |