diff options
| author | Laurence Urhegyi <laurence.urhegyi@codethink.co.uk> | 2018-08-14 11:28:16 +0000 |
|---|---|---|
| committer | Laurence Urhegyi <laurence.urhegyi@codethink.co.uk> | 2018-08-15 16:07:28 +0100 |
| commit | 820721d2fa1c779751ac1a9078f18457da271ab4 (patch) | |
| tree | e0c3d200ab7f36a79337ad4f6055d1f18ae506a9 | |
| parent | 007624429f22972a9d2d2620cbbbad18411ff4c9 (diff) | |
| download | buildstream-patch-1.tar.gz | |
install_linux_distro.rst docs: updated to point user to latest stable branchpatch-1
adds a description of the semantic versioning convention that BuildStream uses
adds a sentence telling users to follow this convention and navigate to the latest tag
| -rw-r--r-- | doc/source/install_linux_distro.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/source/install_linux_distro.rst b/doc/source/install_linux_distro.rst index 0d21bfd46..d07ef2011 100644 --- a/doc/source/install_linux_distro.rst +++ b/doc/source/install_linux_distro.rst @@ -1,4 +1,3 @@ - .. _install: Installing BuildStream on a Linux distro @@ -32,7 +31,15 @@ Installing from source (recommended) ------------------------------------ Until BuildStream is available in your distro, you will need to install it yourself from the `git repository <https://gitlab.com/BuildStream/buildstream.git>`_ -using python's ``pip`` package manager. +using python's ``pip`` package manager. + +BuildStream follows the semantic versioning convention `(SemVer) <https://semver.org>`_ +of releases and development snapshots. So where the version number is X.Y.Z +and the Y is an even number, you have a release, but where Y is an odd number, +you have a development snapshot. For example, 1.0 was the first ever release, +then 1.1 was the development branch that came after it, etc. Therefore, when +downloading from git, please look for the latest tag in the latest branch that +has an even number for Y. For the purpose of installing BuildStream while there are no distro packages, you will additionally need: |