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:40:00 UTC
[buildstream] 01/07: Made come of the changes commented on MR
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