summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2015-06-13 15:56:52 +0300
committerLars Wirzenius <liw@liw.fi>2015-06-13 15:56:52 +0300
commit5281ee45ad1e3c8c6428f80d94dae5f15fb3dc0a (patch)
treeec68cd90216239e8e576cf49bb7d754b25e6a49b /doc
parent6a1e7299c2eb16be0693248e089d4e1b5c9014ae (diff)
downloadick-5281ee45ad1e3c8c6428f80d94dae5f15fb3dc0a.tar.gz
Rename section to be about cleanly
Minor other clarifications. I plan to add a separate section on actually building things.
Diffstat (limited to 'doc')
-rw-r--r--doc/050-debian.yarn10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/050-debian.yarn b/doc/050-debian.yarn
index 878c650..8620720 100644
--- a/doc/050-debian.yarn
+++ b/doc/050-debian.yarn
@@ -205,20 +205,21 @@ FIXME: Further builds should use that APT repository.
FIXME: signing packages?
-## The pipeline implementation
+## The `cleanly` helper tool
The Debian package build pipeline contains a number of steps. To allow
the steps to be easily combined and reordered, the are not integrated
deeply into the Ick program, but provided by a separate helper program
instead, called `cleanly`. This de-couples the pipeline and Ick, and
-allows the pipeline to be used with other CI systems as well.
+allows the pipeline to be used with other CI systems as well. This
+section describes how `cleanly` works.
### Extract project metadata
The first thing we need to do is determine, preferably automatically,
what the name of the project is and what its version is.
- SCENARIO Debian package build pipeline
+ SCENARIO cleanly performs pipeline steps
GIVEN a source code repository for project foo version 1.2-1
WHEN user runs, in foo, cleanly get-name
@@ -250,7 +251,8 @@ flexible later.)
### Build a Debian binary package
This is where things get interesting. We build a Debian binary
-package, given a source package.
+package, given a source package. (Note that for this, we fake the
+actual build to avoid having to have `root` access.)
WHEN user runs, in foo, cleanly deb
THEN file foo_1.2-1_all.deb exists