You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by tv...@apache.org on 2021/02/04 07:39:59 UTC
[buildstream] branch spellcheck created (now a26f94f)
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a change to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git.
at a26f94f buildproject.rst/install.rst: Apply minor text corrections
This branch includes the following new commits:
new 28d4516 Made come of the changes commented on MR
new f3fc16a removed example repo and modified docs
new edfb452 Removed creating project, updated post build and index
new fccba61 updated dependencies
new e25b06c Removed git from run dependencies
new 0969d7e added note about git usage
new a26f94f buildproject.rst/install.rst: Apply minor text corrections
The 7 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[buildstream] 03/07: Removed creating project,
updated post build and index
Posted by tv...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit edfb4524a0a69cd278e7e5fbb1822614405b33a5
Author: Phillip Smyth <ph...@ct-lt-nexus.unassigned>
AuthorDate: Wed Dec 20 16:57:32 2017 +0000
Removed creating project, updated post build and index
---
doc/source/createproject.rst | 169 -------------------------------------------
doc/source/index.rst | 10 ++-
doc/source/postbuild.rst | 3 +-
3 files changed, 7 insertions(+), 175 deletions(-)
diff --git a/doc/source/createproject.rst b/doc/source/createproject.rst
deleted file mode 100644
index 1c63d89..0000000
--- a/doc/source/createproject.rst
+++ /dev/null
@@ -1,169 +0,0 @@
-.. _createproject:
-
-Creating a basic project
-====
-
-This Section assumes you have installed Buildstream already.
-
-If not, go to :ref:`installing`
-
-Or :ref:`docker`
-
-This section will be using files from Cmake-test
-
-
-Setup
-----
-
-If using docker, run::
-
- bst-here
-
-In the directory you want to use.
-
-----
-
-Create File Structure
-~~~~
-
-Create a project directory and in it create the following directories:
-
-* elements
-
-* elements/dependencies
-
-* keys
-
-* src
-
-
-
-
-Source files
-~~~~
-
-There are multiple ways of including source files with buildstream, and this is done through things called plugins.
-
-The list of options can be found here :ref:`plugins_sources`
-
-Each option can be clicked for an example of an "element"
-
-
-If you plan on following along with this tutorial, do the following:
-
- For this example we will be using cmake-test, as it is a relatively small and simple project to build.
-
- Download :download:`step7.tar.gz <../../integration-tests/cmake-test/src/step7.tar.gz>`
-
- This should provide you with `step7.tar.gz`
-
- Move `step7.tar.gz` to `src`
-
-This file is the project repository,
-
-You can include repositories into buildstream in multiple ways.
-
-One of which, is via a local tar.gz
-
-Read :ref:`format_sources` for more information on the different options
-
-
- Download :download:`gnome-sdk.gpg <../../integration-tests/cmake-test/keys/gnome-sdk.gpg>`
-
- This should provide you with `gnome-sdk.gpg`
-
- Move `gnome-sdk.gpg` to `keys`
-
-This key is needed in order to decrypt the files used in this example.
-
-----
-
-Creating the project files
-----
-
-Project.conf
-~~~~
-
-In the root of the project directory create a file called project.conf containing::
-
- name: ProjectName # The name you want to give to your project
- element-path: elements # The relative path to the "elements" directory
- # The elements directory is where your .bst files will be stored
- aliases:
- name: url # This is used so you can moderate the URLs/Repos used by your build.
- # This way, they can be modified in a single place instead of multiple
- # Use this name in place of the url anywhere you would use it
- gnomesdk: https://sdk.gnome.org/
-
- options:
- arch:
- type: arch
- description: The machine architecture
- values:
- - x86_64
- - i386
-
-
-step7.bst
-~~~~
-
-This is the element that is actually being called and build.
-It depends on:
-* usermerge.bst
-* base-sdk.bst
-
-
-
-In the elements directory Create a file called step7.bst containing::
-
- kind: cmake # This is a build element plugin (linked below)
- description: Cmake test
-
- depends:
- - filename: dependencies/usermerge.bst
- type: build
- - filename: dependencies/base-sdk.bst
- type: build
-
- sources:
- - kind: tar # This is a Source Plugin
- url: [PathToProjectDir]/src/step7.tar.gz
-
-:ref:`kind (plugins)<plugins_build>`
-
-:ref:`format_depends`
-
-:ref:`format_sources`
-
-.. this is done until i can find a better way of incorperating hyperlinks into sourcecode blocks
-
-base-sdk.bst
-~~~~
-
-In the elements/dependencies directory Create a file called base-sdk.bst containing::
-
- kind: import
- description: Import the base freedesktop SDK
- sources:
- - kind: ostree
- url: gnomesdk:repo/
- gpg-key: keys/gnome-sdk.gpg
- track: runtime/org.freedesktop.BaseSdk/x86_64/1.4
- ref: 0d9d255d56b08aeaaffb1c820eef85266eb730cb5667e50681185ccf5cd7c882
- config:
- source: files
- target: usr
-
-
-:ref:`format_config`
-
-usermerge.bst
-~~~~
-
-In the elements/dependencies directory Create a file called base-platform.bst containing::
-
- kind: import
- description: Some symlinks for the flatpak runtime environment
- sources:
- - kind: local
- path: files/usrmerge
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 541ba8d..a9a1842 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -18,16 +18,18 @@ These pipelines are composed of abstract elements which perform mutations on
on *filesystem data* as input and output, and are related to eachother by their
dependencies.
+Quick Start
+-----------
+* :ref:`buildproject`
+* :ref:`postbuild`
+* :ref:`modifyingandtesting`
+
Installing
----------
* :ref:`installing`
* :ref:`docker`
* :ref:`artifacts`
-* :ref:`createproject`
-* :ref:`buildproject`
-* :ref:`modifyingandtesting`
-
Running
-------
diff --git a/doc/source/postbuild.rst b/doc/source/postbuild.rst
index daeceb4..9e9a588 100644
--- a/doc/source/postbuild.rst
+++ b/doc/source/postbuild.rst
@@ -19,8 +19,7 @@ This is useful for debugging and ensuring the system built everything properly
Checkout
----
-This command returns all *:ref:artifacts* that are defined in the *:ref:install-root*
-
+This command returns all :ref:`artifacts <artifacts>` that are defined in the install-root
Workspace
----
[buildstream] 07/07: buildproject.rst/install.rst: Apply minor text
corrections
Posted by tv...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit a26f94fa84088ea840514338f4caed5c64c21bc9
Author: Tristan Maat <tr...@codethink.co.uk>
AuthorDate: Wed Dec 20 17:47:15 2017 +0000
buildproject.rst/install.rst: Apply minor text corrections
---
doc/source/buildproject.rst | 19 ++++++++-----------
doc/source/install.rst | 12 ++++++------
2 files changed, 14 insertions(+), 17 deletions(-)
diff --git a/doc/source/buildproject.rst b/doc/source/buildproject.rst
index 1088eeb..57d82a4 100644
--- a/doc/source/buildproject.rst
+++ b/doc/source/buildproject.rst
@@ -3,7 +3,7 @@
Building a basic project
====
-This Section assumes you have installed Buildstream already.
+This section assumes you have installed BuildStream already.
If not, go to :ref:`installing`
@@ -15,7 +15,7 @@ Setup
If using docker, run::
- bst-here
+ bst-here
in the directory you want to use
@@ -32,7 +32,7 @@ Building
Find the .bst file that you want to build
-In this case, we will be using `gedit.bst` in elements/core
+In this case, we will be using `gedit.bst` from elements/core
from the root of the project repo run:
@@ -44,10 +44,10 @@ In this case, Gedit uses "autotools", so will therefore run:
* `autoreconf;`
* `./configure;`
-* `make;`
+* `make;`
* `make install`
-Buildstream will run the commands needed to build each plugin in the same way the user would.
+BuildStream will run the commands needed to build each plugin in the same way the user would.
This removes the need for the user to type dozens of different commands if using multiple build files
@@ -55,9 +55,9 @@ This removes the need for the user to type dozens of different commands if using
If you get an error requesting the use of ``bst track``
-This occurs when a ref has not been provided for an elements source.
+This occurs when a ref has not been provided for an element source.
-This means that buildstream does not know where to look to download something.
+This means that BuildStream does not know where to look to download something.
``bst`` :ref:`invoking_track` resolves this issue by checking for the latest commit on the branch provided in the source of the file.
@@ -71,7 +71,4 @@ Where element is the element listed in the error message
This command will go through each element and repeat the process of tracking them.
-After tracking all untracked elements
-
-Run the build command again and this time it should succeed.
-
+After tracking all untracked elements, run the build command again and this time it should succeed.
diff --git a/doc/source/install.rst b/doc/source/install.rst
index b72b086..28f8816 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -38,7 +38,7 @@ you will additionally need:
* Python 3 development libraries and headers
-* git (to checkout or install buildstream from git)
+* git (to checkout or install BuildStream from git)
Here are some examples of how to prepare the base requirements on
some distros.
@@ -106,7 +106,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::
@@ -117,7 +117,7 @@ git repository and install it as a regular user::
pip3 install --user .
-This will install buildstream and it's pure python dependencies directly into
+This will install BuildStream and its pure python dependencies directly into
your user's home dir in ``~/.local``
@@ -128,7 +128,7 @@ Adjust PATH
Since BuildStream is now installed under your local user's install directories,
you need to ensure that ``PATH`` is adjusted.
-A regular way to do this is to add the following line to the end of your ``~/.bashrc``::
+The regular way to do this is to add the following line to the end of your ``~/.bashrc``::
export PATH=${PATH}:~/.local/bin
@@ -158,8 +158,8 @@ to your ``~/.bash_completion``:
Upgrading with pip
~~~~~~~~~~~~~~~~~~
-To upgrade a previously install BuildStream, you will need to pull the latest
-changes and reinstall as such::
+To upgrade a previously installed BuildStream, you will need to pull
+the latest changes and reinstall as such::
pip3 uninstall buildstream
[buildstream] 01/07: Made come of the changes commented on MR
Posted by tv...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit 28d45165763ae394915e7523d91a8683176676ff
Author: Phillip Smyth <ph...@ct-lt-nexus.unassigned>
AuthorDate: Wed Dec 20 13:11:17 2017 +0000
Made come of the changes commented on MR
---
doc/source/buildproject.rst | 34 +++++++++++---
doc/source/cmake.tar.gz | Bin 0 -> 380586 bytes
doc/source/createproject.rst | 52 +++++++++++----------
doc/source/example_projects/gnome-modulesets.tar | Bin 0 -> 5836800 bytes
doc/source/install.rst | 11 +----
doc/source/postbuild.rst | 1 +
.../autotools-test/elements/amhello.bst | 2 +-
integration-tests/bzr-test/elements/bzr-test.bst | 2 +-
integration-tests/cmake-test/elements/step7.bst | 2 +-
.../elements/dependencies/amhello-full.bst | 2 +-
.../compose-test/elements/dependencies/amhello.bst | 2 +-
.../compose-exclude-debug/usr/lib/.gitkeep | 0
.../expected/compose-no-debug/usr/lib/.gitkeep | 0
.../expected/compose-no-doc/usr/share/.gitkeep | 0
.../expected/compose-only-runtime/usr/lib/.gitkeep | 0
.../compose-only-runtime/usr/share/.gitkeep | 0
integration-tests/pip-test/elements/hello.bst | 2 +-
17 files changed, 65 insertions(+), 45 deletions(-)
diff --git a/doc/source/buildproject.rst b/doc/source/buildproject.rst
index 300fa13..8b71855 100644
--- a/doc/source/buildproject.rst
+++ b/doc/source/buildproject.rst
@@ -38,20 +38,42 @@ In this case, we will be using `gedit.bst` in elements/core
from the root of the project repo run:
- ``bst`` :ref:`invoking_build` ``gedit.bst``
-
-In this case, that would be core/gedit.bst
+ ``bst`` :ref:`invoking_build` ``core/gedit.bst``
This will try to build the project.
+In this case, Gedit uses "autotools", so will therefore run:
+
+* `autoreconf;`
+* `./configure;`
+* `make;`
+* `make install`
+
+Buildstream will run the commands needed to build each plugin in the same way the user would.
+
+This removes the need for the user to type dozens of different commands if using multiple build files
+
----
If you get an error requesting the use of ``bst track``
-run:
- ``bst`` :ref:`invoking_track` ``--deps all gedit.bst``
+This occurs when a ref has not been provided for an elements source.
+
+This means that buildstream does not know where to look to download something.
+
+``bst`` :ref:`invoking_track` resolves this issue by checking for the latest commit on the branch provided in the source of the file.
+
+There are 2 main ways of resolving this:
+
+1: run ``bst`` :ref:`invoking_track` `` [element]
+
+Where element is the element listed in the error message
+
+2: run: ``bst`` :ref:`invoking_track` ``--deps all core/gedit.bst``
+
+This command will go through each element and repeat the process of tracking them.
-This command updates all project dependencies.
+After tracking all untracked elements
Run the build command again and this time it should succeed.
diff --git a/doc/source/cmake.tar.gz b/doc/source/cmake.tar.gz
new file mode 100644
index 0000000..ca144ae
Binary files /dev/null and b/doc/source/cmake.tar.gz differ
diff --git a/doc/source/createproject.rst b/doc/source/createproject.rst
index 3de2dc5..1c63d89 100644
--- a/doc/source/createproject.rst
+++ b/doc/source/createproject.rst
@@ -42,7 +42,7 @@ Create a project directory and in it create the following directories:
Source files
~~~~
-There are multiple ways of including source files with build stream, and this is done though things called plugins.
+There are multiple ways of including source files with buildstream, and this is done through things called plugins.
The list of options can be found here :ref:`plugins_sources`
@@ -51,8 +51,6 @@ Each option can be clicked for an example of an "element"
If you plan on following along with this tutorial, do the following:
- Install wget or some other download tool.
-
For this example we will be using cmake-test, as it is a relatively small and simple project to build.
Download :download:`step7.tar.gz <../../integration-tests/cmake-test/src/step7.tar.gz>`
@@ -61,6 +59,14 @@ If you plan on following along with this tutorial, do the following:
Move `step7.tar.gz` to `src`
+This file is the project repository,
+
+You can include repositories into buildstream in multiple ways.
+
+One of which, is via a local tar.gz
+
+Read :ref:`format_sources` for more information on the different options
+
Download :download:`gnome-sdk.gpg <../../integration-tests/cmake-test/keys/gnome-sdk.gpg>`
@@ -68,10 +74,9 @@ If you plan on following along with this tutorial, do the following:
Move `gnome-sdk.gpg` to `keys`
-----
-
-Alternatively, you can link to your project using one of the options in sources or tar.gz your projects and use it in place of step7.tar.gz
+This key is needed in order to decrypt the files used in this example.
+----
Creating the project files
----
@@ -102,13 +107,20 @@ In the root of the project directory create a file called project.conf containin
step7.bst
~~~~
+This is the element that is actually being called and build.
+It depends on:
+* usermerge.bst
+* base-sdk.bst
+
+
+
In the elements directory Create a file called step7.bst containing::
kind: cmake # This is a build element plugin (linked below)
description: Cmake test
depends:
- - filename: dependencies/base-platform.bst
+ - filename: dependencies/usermerge.bst
type: build
- filename: dependencies/base-sdk.bst
type: build
@@ -130,36 +142,28 @@ base-sdk.bst
In the elements/dependencies directory Create a file called base-sdk.bst containing::
- kind: import
- description: Import the base freedesktop SDK
- sources:
+ kind: import
+ description: Import the base freedesktop SDK
+ sources:
- kind: ostree
url: gnomesdk:repo/
gpg-key: keys/gnome-sdk.gpg
track: runtime/org.freedesktop.BaseSdk/x86_64/1.4
+ ref: 0d9d255d56b08aeaaffb1c820eef85266eb730cb5667e50681185ccf5cd7c882
config:
source: files
target: usr
+
:ref:`format_config`
-base-platform.bst
+usermerge.bst
~~~~
In the elements/dependencies directory Create a file called base-platform.bst containing::
kind: import
- description: Import the base freedesktop platform
+ description: Some symlinks for the flatpak runtime environment
sources:
- - kind: ostree
- url: gnomesdk:repo/
- gpg-key: keys/gnome-sdk.gpg
- track: runtime/org.freedesktop.BasePlatform/x86_64/1.4
- config:
- source: files
- public:
- bst:
- integration-commands:
- - ldconfig
-
-:ref:`format_public`
+ - kind: local
+ path: files/usrmerge
diff --git a/doc/source/example_projects/gnome-modulesets.tar b/doc/source/example_projects/gnome-modulesets.tar
new file mode 100644
index 0000000..5c420ac
Binary files /dev/null and b/doc/source/example_projects/gnome-modulesets.tar differ
diff --git a/doc/source/install.rst b/doc/source/install.rst
index cb4d46a..1112c58 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -17,17 +17,10 @@ BuildStream requires the following base system requirements:
* python3 >= 3.4
* ruamel.yaml python library
* OSTree >= v2017.8 with introspection data
-* build-essential
* git
-* gir1.2-ostree-1* bubblewrap
-* dh-autoreconf
-* libglib2.0-dev
-* bison
-* liblzma-dev
-* e2fslibs-dev
+* gir1.2-ostree-1
+* bubblewrap
* gobject-introspection
-* libostree-dev
-* libgirepository1.0-dev
Note that ``ruamel.yaml`` is a pure python library which is normally
diff --git a/doc/source/postbuild.rst b/doc/source/postbuild.rst
index fd084ad..daeceb4 100644
--- a/doc/source/postbuild.rst
+++ b/doc/source/postbuild.rst
@@ -27,3 +27,4 @@ Workspace
This command returns the source code of the target project to a target directory,
providing you with a safe copy of your sourcecode to modify.
+
diff --git a/integration-tests/autotools-test/elements/amhello.bst b/integration-tests/autotools-test/elements/amhello.bst
index 5dc13b4..5f929fd 100644
--- a/integration-tests/autotools-test/elements/amhello.bst
+++ b/integration-tests/autotools-test/elements/amhello.bst
@@ -9,5 +9,5 @@ depends:
sources:
- kind: tar
- url: file:///amhello.tar.gz
+ url: file:///home/phillipsmyth/projects/buildstream/integration-tests/autotools-test/src/amhello.tar.gz
ref: 3aa3c2bf7a488fea24303c4d98d1b5c0a72734f61615b935cf62e4e126b127d2
diff --git a/integration-tests/bzr-test/elements/bzr-test.bst b/integration-tests/bzr-test/elements/bzr-test.bst
index 25349ca..1f0c1c6 100644
--- a/integration-tests/bzr-test/elements/bzr-test.bst
+++ b/integration-tests/bzr-test/elements/bzr-test.bst
@@ -9,7 +9,7 @@ depends:
sources:
- kind: bzr
- url: file:///src
+ url: file:///home/phillipsmyth/projects/buildstream/integration-tests/bzr-test/src
track: trunk
ref: '2'
diff --git a/integration-tests/cmake-test/elements/step7.bst b/integration-tests/cmake-test/elements/step7.bst
index bd4d1f3..020d526 100644
--- a/integration-tests/cmake-test/elements/step7.bst
+++ b/integration-tests/cmake-test/elements/step7.bst
@@ -9,5 +9,5 @@ depends:
sources:
- kind: tar
- url: file:///home/tristanmaat/Documents/Projects/buildstream/buildstream-tests/cmake-test/src/step7.tar.gz
+ url: file:///home/phillipsmyth/projects/buildstream/integration-tests/cmake-test/src/step7.tar.gz
ref: 9591707afbae77751730b4af4c52a18b1cdc4378237bc64055f099bc95c330db
diff --git a/integration-tests/compose-test/elements/dependencies/amhello-full.bst b/integration-tests/compose-test/elements/dependencies/amhello-full.bst
index 29e94bf..0fae9d5 100644
--- a/integration-tests/compose-test/elements/dependencies/amhello-full.bst
+++ b/integration-tests/compose-test/elements/dependencies/amhello-full.bst
@@ -7,5 +7,5 @@ depends:
sources:
- kind: tar
- url: file:///home/tristanmaat/Documents/Projects/buildstream/buildstream-tests/compose-test/src/amhello.tar.gz
+ url: file:///home/phillipsmyth/projects/buildstream/integration-tests/compose-test/src/amhello.tar.gz
ref: 3aa3c2bf7a488fea24303c4d98d1b5c0a72734f61615b935cf62e4e126b127d2
diff --git a/integration-tests/compose-test/elements/dependencies/amhello.bst b/integration-tests/compose-test/elements/dependencies/amhello.bst
index 2e09158..00a123d 100644
--- a/integration-tests/compose-test/elements/dependencies/amhello.bst
+++ b/integration-tests/compose-test/elements/dependencies/amhello.bst
@@ -9,5 +9,5 @@ depends:
sources:
- kind: tar
- url: file:///home/tristanmaat/Documents/Projects/buildstream/buildstream-tests/compose-test/src/amhello.tar.gz
+ url: file:///home/phillipsmyth/projects/buildstream/integration-tests/compose-test/src/amhello.tar.gz
ref: 3aa3c2bf7a488fea24303c4d98d1b5c0a72734f61615b935cf62e4e126b127d2
diff --git a/integration-tests/compose-test/expected/compose-exclude-debug/usr/lib/.gitkeep b/integration-tests/compose-test/expected/compose-exclude-debug/usr/lib/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/integration-tests/compose-test/expected/compose-no-debug/usr/lib/.gitkeep b/integration-tests/compose-test/expected/compose-no-debug/usr/lib/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/integration-tests/compose-test/expected/compose-no-doc/usr/share/.gitkeep b/integration-tests/compose-test/expected/compose-no-doc/usr/share/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/integration-tests/compose-test/expected/compose-only-runtime/usr/lib/.gitkeep b/integration-tests/compose-test/expected/compose-only-runtime/usr/lib/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/integration-tests/compose-test/expected/compose-only-runtime/usr/share/.gitkeep b/integration-tests/compose-test/expected/compose-only-runtime/usr/share/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/integration-tests/pip-test/elements/hello.bst b/integration-tests/pip-test/elements/hello.bst
index 3d02428..5392257 100644
--- a/integration-tests/pip-test/elements/hello.bst
+++ b/integration-tests/pip-test/elements/hello.bst
@@ -12,5 +12,5 @@ depends:
sources:
- kind: tar
- url: file:///hello.tar.xz
+ url: file:///home/phillipsmyth/projects/buildstream/integration-tests/pip-test/src/hello.tar.xz
ref: ad96570b552498807abec33c06210bf68378d854ced6753b77916c5ed517610d
[buildstream] 06/07: added note about git usage
Posted by tv...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit 0969d7eac20d9b548b93ec45ce658511b7d6dc0e
Author: Phillip Smyth <ph...@ct-lt-nexus.unassigned>
AuthorDate: Wed Dec 20 17:11:22 2017 +0000
added note about git usage
---
doc/source/install.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/doc/source/install.rst b/doc/source/install.rst
index ad5810a..b72b086 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -38,6 +38,7 @@ you will additionally need:
* Python 3 development libraries and headers
+* git (to checkout or install buildstream from git)
Here are some examples of how to prepare the base requirements on
some distros.
[buildstream] 02/07: removed example repo and modified docs
Posted by tv...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit f3fc16aad027a44dc4509c25f5b8211280c2407c
Author: Phillip Smyth <ph...@ct-lt-nexus.unassigned>
AuthorDate: Wed Dec 20 15:37:35 2017 +0000
removed example repo and modified docs
---
doc/source/buildproject.rst | 6 +--
doc/source/example_projects/gnome-modulesets.tar | Bin 5836800 -> 0 bytes
doc/source/install.rst | 53 +++++++++++++++++++----
3 files changed, 47 insertions(+), 12 deletions(-)
diff --git a/doc/source/buildproject.rst b/doc/source/buildproject.rst
index 8b71855..1088eeb 100644
--- a/doc/source/buildproject.rst
+++ b/doc/source/buildproject.rst
@@ -21,12 +21,10 @@ in the directory you want to use
----
-If not already installed, install `git`
-
This example will be using `gnome-modulesets`, but this will apply to any buildable repo
-Download :download:`gnome modulesets <example_projects/gnome-modulesets.tar>`
-
+Download or clone `gnome-Modulesets <http://gnome7.codethink.co.uk/gnome-modulesets.git/>`_
+
Then move into the repo
Building
diff --git a/doc/source/example_projects/gnome-modulesets.tar b/doc/source/example_projects/gnome-modulesets.tar
deleted file mode 100644
index 5c420ac..0000000
Binary files a/doc/source/example_projects/gnome-modulesets.tar and /dev/null differ
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 1112c58..f307cd0 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -2,16 +2,20 @@
BuildStream on your host
========================
+
Until BuildStream is available in your distro, there are a few hoops to jump
through to get started.
+
If your system cannot provide the base system requirements for BuildStream,
then we have some instructions below which can get you started using BuildStream
within a Docker container.
+
System requirements
-------------------
+
BuildStream requires the following base system requirements:
* python3 >= 3.4
@@ -23,28 +27,35 @@ BuildStream requires the following base system requirements:
* gobject-introspection
+
Note that ``ruamel.yaml`` is a pure python library which is normally
-obtainable via pip, however there seems to be some problems with installing
+obtainable via pip, however, there seem to be some problems with installing
this package so we recommend installing it with your package manager first.
For the purpose of installing BuildStream while there are no distro packages,
you will additionally need:
+
* pip for python3 (only required for setup)
+
* Python 3 development libraries and headers
+
Here are some examples of how to prepare the base requirements on
some distros.
+
Arch
~~~~
-Install the dependencies with:
+
+Install the dependencies with::
sudo pacman -S python python-pip python-gobject git \
ostree bubblewrap python-ruamel-yaml
Debian Stretch
~~~~~~~~~~~~~
+
With stretch, you first need to ensure that you have the backports repository
setup as described `here <https://backports.debian.org/Instructions/>`_
@@ -56,19 +67,22 @@ And then running::
sudo apt-get update
-At this point you should be able to get the system requirements with::
+At this point, you should be able to get the system requirements with::
+
sudo apt-get install \
python3-dev python3-pip git python3-gi \
python3-ruamel.yaml bubblewrap
+
sudo apt-get install -t stretch-backports \
gir1.2-ostree-1.0 ostree
+
Debian Buster or Sid
~~~~~~~~~~~~~~~~~~~~~
-For debian unstable or testing, the following line should be enough
+For Debian unstable or testing, the following line should be enough
to get most of the base system requirements installed::
sudo apt-get install \
@@ -78,60 +92,83 @@ to get most of the base system requirements installed::
bubblewrap ruamel.yaml
bubblewrap python3-ruamel.yaml
+
Fedora
~~~~~~
-For recent fedora systems, the following line should get you the system
+
+For recent Fedora systems, the following line should get you the system
requirements you need::
+
dnf install -y bubblewrap fuse git python3-gobject \
python3-psutil ostree
-
User installation with pip
--------------------------
+
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
+
cd buildstream
+
pip3 install --user .
+
This will install buildstream and it's pure python dependencies directly into
-your user's homedir in ``~/.local``
+your user's home dir in ``~/.local``
+
Adjust PATH
~~~~~~~~~~~
+
Since BuildStream is now installed under your local user's install directories,
you need to ensure that ``PATH`` is adjusted.
A regular way to do this is to add the following line to the end of your ``~/.bashrc``::
+
export PATH=${PATH}:~/.local/bin
+
Bash Completions
+
~~~~~~~~~~~~~~~~
+
Bash completions are supported by sourcing the ``buildstream/data/bst``
script found in the BuildStream repository. On many systems this script
can be installed into a completions directory but when installing BuildStream
-without a package manager this is not an option.
+without a package manager, this is not an option.
+
To enable completions for an installation of BuildStream you
installed yourself from git, just append the script verbatim
to your ``~/.bash_completion``:
+
.. literalinclude:: ../../buildstream/data/bst
+
:language: yaml
Upgrading with pip
~~~~~~~~~~~~~~~~~~
+
To upgrade a previously install BuildStream, you will need to pull the latest
changes and reinstall as such::
+
pip3 uninstall buildstream
+
cd buildstream
+
git pull --rebase
+
pip3 install --user .
+
+
[buildstream] 05/07: Removed git from run dependencies
Posted by tv...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit e25b06c308596103e904149ce6f6279182c38fed
Author: Phillip Smyth <ph...@ct-lt-nexus.unassigned>
AuthorDate: Wed Dec 20 17:09:54 2017 +0000
Removed git from run dependencies
---
doc/source/install.rst | 1 -
1 file changed, 1 deletion(-)
diff --git a/doc/source/install.rst b/doc/source/install.rst
index aaf9816..ad5810a 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -21,7 +21,6 @@ BuildStream requires the following base system requirements:
* python3 >= 3.4
* ruamel.yaml python library
* OSTree >= v2017.8 with introspection data
-* git
* bubblewrap
* gobject-introspection
[buildstream] 04/07: updated dependencies
Posted by tv...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tvb pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit fccba610a85014e70f1421e675dfab75ec727219
Author: Phillip Smyth <ph...@ct-lt-nexus.unassigned>
AuthorDate: Wed Dec 20 17:09:06 2017 +0000
updated dependencies
---
doc/source/install.rst | 1 -
1 file changed, 1 deletion(-)
diff --git a/doc/source/install.rst b/doc/source/install.rst
index f307cd0..aaf9816 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -22,7 +22,6 @@ BuildStream requires the following base system requirements:
* ruamel.yaml python library
* OSTree >= v2017.8 with introspection data
* git
-* gir1.2-ostree-1
* bubblewrap
* gobject-introspection