summaryrefslogtreecommitdiff
path: root/doc/examples
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-18 15:01:47 -0400
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-18 15:17:52 -0400
commitb4105e8dea0f4aaaefbbd5a5dce344a939e736dc (patch)
tree6ef0af24afde022eea9b7ac00646314b0a711d15 /doc/examples
parent72fbaa1c0c0f3ff59db0f8bd34268918c6db9865 (diff)
downloadbuildstream-b4105e8dea0f4aaaefbbd5a5dce344a939e736dc.tar.gz
doc: Adding part 3 of the getting started tutorial: autotools element
This part of the tutorial uses a lot of the work from Phil Dawson and James Ennis, and uses their example submitted on merge request 499 as a basis to introduce the user to yaml composition and variable resolution. This is a part of issue #103
Diffstat (limited to 'doc/examples')
-rw-r--r--doc/examples/autotools/elements/base.bst5
-rw-r--r--doc/examples/autotools/elements/base/alpine.bst13
-rw-r--r--doc/examples/autotools/elements/hello.bst21
-rw-r--r--doc/examples/autotools/project.conf13
4 files changed, 52 insertions, 0 deletions
diff --git a/doc/examples/autotools/elements/base.bst b/doc/examples/autotools/elements/base.bst
new file mode 100644
index 000000000..1b85a9e8c
--- /dev/null
+++ b/doc/examples/autotools/elements/base.bst
@@ -0,0 +1,5 @@
+kind: stack
+description: Base stack
+
+depends:
+- base/alpine.bst
diff --git a/doc/examples/autotools/elements/base/alpine.bst b/doc/examples/autotools/elements/base/alpine.bst
new file mode 100644
index 000000000..cf85df5bf
--- /dev/null
+++ b/doc/examples/autotools/elements/base/alpine.bst
@@ -0,0 +1,13 @@
+kind: import
+description: |
+
+ Alpine Linux base runtime
+
+sources:
+- kind: tar
+
+ # This is a post doctored, trimmed down system image
+ # of the Alpine linux distribution.
+ #
+ url: alpine:integration-tests-base.v1.x86_64.tar.xz
+ ref: 3eb559250ba82b64a68d86d0636a6b127aa5f6d25d3601a79f79214dc9703639
diff --git a/doc/examples/autotools/elements/hello.bst b/doc/examples/autotools/elements/hello.bst
new file mode 100644
index 000000000..510f5b975
--- /dev/null
+++ b/doc/examples/autotools/elements/hello.bst
@@ -0,0 +1,21 @@
+kind: autotools
+description: |
+
+ Hello world example from automake
+
+variables:
+
+ # The hello world example lives in the doc/amhello folder.
+ #
+ # Set the %{command-subdir} variable to that location
+ # and just have the autotools element run it's commands there.
+ #
+ command-subdir: doc/amhello
+
+sources:
+- kind: tar
+ url: gnu:automake-1.16.tar.gz
+ ref: 80da43bb5665596ee389e6d8b64b4f122ea4b92a685b1dbd813cd1f0e0c2d83f
+
+depends:
+- base.bst
diff --git a/doc/examples/autotools/project.conf b/doc/examples/autotools/project.conf
new file mode 100644
index 000000000..61f63c43a
--- /dev/null
+++ b/doc/examples/autotools/project.conf
@@ -0,0 +1,13 @@
+# Unique project name
+name: running-commands
+
+# Required BuildStream format version
+format-version: 9
+
+# Subdirectory where elements are stored
+element-path: elements
+
+# Define an alias for our alpine tarball
+aliases:
+ alpine: https://gnome7.codethink.co.uk/tarballs/
+ gnu: https://ftp.gnu.org/gnu/automake/