diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-08-25 20:14:13 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-08-25 11:42:08 +0000 |
| commit | 086325683215b5f174f9c57d791b4a1f705d5b20 (patch) | |
| tree | b81fdec353fc1316c25a96be3c3ac0b47508589b | |
| parent | a1fa504d580fc5ccbb0808389327c59ebd7e7d69 (diff) | |
| download | buildstream-086325683215b5f174f9c57d791b4a1f705d5b20.tar.gz | |
doc/source/install_source.rst: Explain about release tag in git install instructions.
This obsoletes Laurence's explanation in merge request !657, and
is a part of the initiative of issue #528 to clarify which versions
users should be installing.
| -rw-r--r-- | doc/source/install_source.rst | 15 | ||||
| -rw-r--r-- | doc/source/install_versions.rst | 2 |
2 files changed, 17 insertions, 0 deletions
diff --git a/doc/source/install_source.rst b/doc/source/install_source.rst index 9419ce532..5fa0c0603 100644 --- a/doc/source/install_source.rst +++ b/doc/source/install_source.rst @@ -154,6 +154,11 @@ python package as a regular user. Installing from PyPI (recommended) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Since we only ever publish :ref:`release versions <install_semantic_versioning>` on +PyPI, it is currently recommended to use this installation path. This will +ensure that you always have the latest recommended version of BuildStream that +we recommend. + To install from PyPI, you will additionally require: * pip for python3 (only required for setup) @@ -183,6 +188,8 @@ to the latest recommended version like so:: pip install --user --upgrade BuildStream +.. _install_git_checkout: + Installing from a git checkout ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To install directly from the `git repository <https://gitlab.com/BuildStream/buildstream.git>`_ @@ -192,10 +199,18 @@ using python's ``pip`` package manager, you will additionally require: * Python 3 development libraries and headers * git (to checkout BuildStream) +Before installing, please check the existing tags in the git repository +and determine which version you want to install, and whether you want +to install an official release version (recommended), or a development snapshot +to help us out testing the bleeding edge of development. Follow the +:ref:`semantic versioning guide <install_semantic_versioning>` to determine +which tag you intend to install. + Run the following commands:: git clone https://gitlab.com/BuildStream/buildstream.git cd buildstream + git checkout <desired release tag> pip3 install --user -e . This will install buildstream's pure python dependencies into diff --git a/doc/source/install_versions.rst b/doc/source/install_versions.rst index 381b4ec44..a82cb9dc7 100644 --- a/doc/source/install_versions.rst +++ b/doc/source/install_versions.rst @@ -1,5 +1,7 @@ +.. _install_semantic_versioning: + Semantic Versioning =================== BuildStream follows the Semantic Versioning Convention `(SemVer) <https://semver.org/>`_, |