diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-01-08 16:39:58 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-01-08 16:39:58 +0900 |
| commit | 6b5ba80f3203abeb5886f537b51de6f16baf0ba7 (patch) | |
| tree | 1aee3cc66728999a5f8c994c4953d478af9572e7 | |
| parent | d35896e1897329d4715ba65a25074f6710bbf765 (diff) | |
| download | buildstream-6b5ba80f3203abeb5886f537b51de6f16baf0ba7.tar.gz | |
doc/source/install.rst: Add a note here about pip's `-e` developer option
It's more suitable to add this note here than to have a separate section
in the HACKING.rst for this.
| -rw-r--r-- | doc/source/install.rst | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/source/install.rst b/doc/source/install.rst index 9ada0bddc..518f3aa20 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -87,7 +87,7 @@ requirements you need:: User installation with pip -------------------------- -Once you have the base system dependencies, you can clone the buildstream +Once you have the base system dependencies, you can clone the BuildStream git repository and install it as a regular user:: git clone https://gitlab.com/BuildStream/buildstream.git @@ -97,6 +97,17 @@ git repository and install it as a regular user:: This will install buildstream and it's pure python dependencies directly into your user's homedir in ``~/.local`` +If you are installing as a developer and want to easily test changes +or if you would like to update your BuildStream installation via git, +then you can specify the ``-e`` option when invoking pip:: + + pip3 install --user -e . + +.. warning:: + + This will run BuildStream directly from your git checkout and will break + if you ever move the git checkout or run ``git clean -xdf``. + Adjust PATH ~~~~~~~~~~~ |