Skip to content

Commit

Permalink
doc: Add the in-tree-build option to install docs
Browse files Browse the repository at this point in the history
This is required for the setuptools_scm package to correctly identify
the root of the git repository when installing from the
requirements.txt file in the root. It'd otherwise copy the source
directory, which doesn't yet include the version metadata, into a
separate directory and the building from there, which breaks the
git lookup.

`in-tree-build` is the future default, so we'll eventually be able to
strip that option again. See [1] for details.

[1] pypa/pip#7555
  • Loading branch information
cdecker committed Sep 28, 2021
1 parent 7174028 commit ec75090
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Clone lightning:
For development or running tests, get additional dependencies:

sudo apt-get install -y valgrind python3-pip libpq-dev
sudo pip3 install -r requirements.txt
sudo pip3 install -r requirements.txt --use-feature=in-tree-build

Build lightning:

Expand Down

0 comments on commit ec75090

Please sign in to comment.