upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-02-18 18:19:16 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update install docs to include SETUPTOOLS_SCM_PRETEND_VERSION

Browse source
This commit is contained in:
Daniel Rudolf 2025-09-13 20:37:52 +02:00
parent 7b0b334cb4
commit 8f63d984be
No known key found for this signature in database
GPG key ID: A061F02CD8DE4538
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/installation.rst
View file

@ -415,6 +415,10 @@ While we try not to break master, there are no guarantees on anything.
Ensure to install the dependencies as described within :ref:`source-install`.
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
@ -424,11 +428,15 @@ Ensure to install the dependencies as described within :ref:`source-install`.
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