upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-04-22 14:49:03 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #9015 from PhrozenByte/docs-build-src-version

Browse source 
Update install docs to include `SETUPTOOLS_SCM_PRETEND_VERSION`
This commit is contained in:
TW 2025-09-21 15:43:12 +02:00 committed by GitHub
commit 5b85f47618
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
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

@ -428,6 +428,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
@ -437,11 +441,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