X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper%2Fbuild-run-debug%2Fbuilding.rst;fp=docs%2Fdeveloper%2Fbuild-run-debug%2Fbuilding.rst;h=9e9e79db37618cecd1ed505ab9a9a7a9ac8883dc;hb=c142cd115b6e5c95faffd7735fbee835c8538089;hp=ca7fdef02229055361c61662b8cb9cb04cbc98a6;hpb=e462e543b2c672ec6869a9d3653605ea7084d565;p=vpp.git

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
 --------------------------------------