summaryrefslogtreecommitdiffstats
path: root/examples/packages/README.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-02-10 19:14:55 +0100
committerMatthias Beyer <mail@beyermatthias.de>2021-02-11 18:22:38 +0100
commitc2fb88e4ea953d4dbc01ffc6341ccb4e9e59290c (patch)
tree8b6d21dd6a91a6e014beecb58bff32cd08542d06 /examples/packages/README.md
parentf1eca4972dafc3e5eeb63a1efd65f76d2d7c6ed4 (diff)
Remove simple examples, add complex one
This patch removes the many simple examples and replaces them with one big example repository with 26 packages that have a complex dependency setup. This is nice for testing. Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
Diffstat (limited to 'examples/packages/README.md')
-rw-r--r--examples/packages/README.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/examples/packages/README.md b/examples/packages/README.md
new file mode 100644
index 0000000..5271689
--- /dev/null
+++ b/examples/packages/README.md
@@ -0,0 +1,69 @@
+# Example package tree
+
+This subtree contains a large number of "packages", whereas each "package" is
+nothing more than a number piped to a file.
+This can be used to test out butido and how it works.
+
+
+## The packages
+
+Each package has a single-letter name ('a'..'z') and a version number that
+increases for each package, so 'a' has version '1', and 'b' has version '2' and
+so on.
+
+The hierarchy of packages is described as follows:
+
+ A
+ +
+ |
+ +---------------+----------------+
+ | |
+ v v
+ B C
+ + +
+ | +--------------------+
+ +-------------+ | | |
+ v v v v v v
+ D E F+--------+ G H I
+ + + + | + +
+ | | | | | +---+---+
+ v v v +---+-+-+---+ v v
+ J K L | | | | Q R
+ + + + v v v v +
+ +--+---+ | | M N O P |
+ v v | v + + v
+ S T +----->U | | V
+ + | | +
+ | | | |
+ | | | v
+ | | | W
+ | | | +
+ | | | |
+ | | | v
+ +-----------------+---+-------> X
+ +
+ |
+ v
+ Y
+ +
+ |
+ v
+ Z
+
+
+The important features here:
+
+* A simple chain of dependencies: Q -> V -> W -> X -> Y -> Z
+* DAG-Features (non-treeish dependencies):
+ * F -> M
+ * K -> U
+ * O -> X
+ * P -> X
+
+
+The order of builds should be opposite of the arrows, with builds for Z, R, H,
+N, M, T and S starting right away.
+
+
+Multiple versions of one package are not yet considered in this setup.
+