From d9dae4220f9c5daeb193d62d8e62cc08ef842256 Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Sat, 13 Sep 2025 20:37:52 +0200 Subject: [PATCH] Update install docs to include `SETUPTOOLS_SCM_PRETEND_VERSION` --- docs/installation.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index 016ba445a..4e8c0f1a8 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -372,6 +372,10 @@ Ensure to install the dependencies as described within :ref:`source-install`. This uses latest, unreleased development code from git. While we try not to break master, there are no guarantees on anything. +Version metadata is obtained dynamically at install time using ``setuptools-scm``. +Please ensure that your git repo either has correct tags, or provide the version +manually using the ``SETUPTOOLS_SCM_PRETEND_VERSION`` environment variable. + :: # get borg from github @@ -381,11 +385,15 @@ While we try not to break master, there are no guarantees on anything. virtualenv --python=$(which python3) borg-env source borg-env/bin/activate # always before using! - # install borg + dependencies into virtualenv + # install borg dependencies into virtualenv cd borg pip install -r requirements.d/development.txt pip install -r requirements.d/docs.txt # optional, to build the docs + # set a borg version if setuptools-scm fails to do so automatically + export SETUPTOOLS_SCM_PRETEND_VERSION= + + # install borg into virtualenv pip install -e . # in-place editable mode or pip install -e .[pyfuse3] # in-place editable mode, use pyfuse3