path: root/README
diff options
authorSam Thursfield <>2016-02-29 18:47:39 +0000
committerBaserock Gerrit <>2016-02-29 18:54:48 +0000
commitba09c5478d9c814668130c8db531938fba781495 (patch)
treeefc7d9b626a3743289c1e3fa7b6e66a4fb14e53a /README
parent42d6d5d9e9a1c6ff5756a98562dae1bb8516d75e (diff)
Update README for separate definitions spec repo
Change-Id: I2099c07f6add8bb7ab14e203037a76dd24996342
Diffstat (limited to 'README')
1 files changed, 12 insertions, 9 deletions
diff --git a/README b/README
index ed52d721..ec38f9df 100644
--- a/README
+++ b/README
@@ -8,22 +8,23 @@ These are some example definitions for use with Baserock tooling. You can fork
this repo and develop your own systems directly within it, or use it as a
reference point when developing your own set of definitions.
-These definitions follow the Baserock definitions format, which is described at
-<>, and also partly in the schemas/
+These definitions follow the Baserock definitions format, which is defined in
+spec.git repository (
+The spec is readable online at <>.
The systems listed in the systems/ directory are example systems
that build and run at some point. The only ones we can be sure
that still build in current master of definitions are the ones that
we keep building in our ci system; they are listed in
Keeping up to date
The Baserock definitions format is evolving. A set of automated migrations is
-provided in the migrations/ directory, for use when the format has changed and
-you want to bring your definitions up to date.
+provided in the migrations/ directory of spec.git, for use when the format has
+changed and you want to bring your definitions up to date.
Before running the migrations, you can use the 'migrations/indent' tool to
format the definitions in the specific style that the migrations expect.
@@ -37,13 +38,15 @@ so you can clearly see what changes they made, and can then choose to either
commit them, tweak them, or revert them with `git reset --hard` and write an
angry email.
-The suggested workflow is:
+The suggested workflow is to run this from within your definitions.git clone:
+ git clone git:// ../spec.git
git status # ensure a clean Git tree
- migrations/indent
+ ../spec/migrations/indent
git diff # check for any spurious changes
git commit -a -m "Fix formatting"
- migrations/run-all
+ ../spec/migrations/run-all
git diff # check the results
git commit -a -m "Migrate to version xx of Baserock definitions format"