Browse Source

Update install docs to include `SETUPTOOLS_SCM_PRETEND_VERSION`

Daniel Rudolf 1 month ago
parent
commit
d9dae4220f
1 changed files with 9 additions and 1 deletions
  1. 9 1
      docs/installation.rst

+ 9 - 1
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.
 This uses latest, unreleased development code from git.
 While we try not to break master, there are no guarantees on anything.
 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
     # 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
     virtualenv --python=$(which python3) borg-env
     source borg-env/bin/activate   # always before using!
     source borg-env/bin/activate   # always before using!
 
 
-    # install borg + dependencies into virtualenv
+    # install borg dependencies into virtualenv
     cd borg
     cd borg
     pip install -r requirements.d/development.txt
     pip install -r requirements.d/development.txt
     pip install -r requirements.d/docs.txt  # optional, to build the docs
     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
     pip install -e .           # in-place editable mode
     or
     or
     pip install -e .[pyfuse3]  # in-place editable mode, use pyfuse3
     pip install -e .[pyfuse3]  # in-place editable mode, use pyfuse3