aboutsummaryrefslogtreecommitdiff
path: root/doc/cuirass.texi
diff options
context:
space:
mode:
authorMathieu Othacehe <m.othacehe@gmail.com>2017-07-31 19:25:28 +0200
committerMathieu Othacehe <m.othacehe@gmail.com>2017-09-08 21:00:57 +0200
commite550cb6a9a9c8b42f9be88cc49d7b72232097045 (patch)
tree848641ed7b4fd4733ea43e02d5dabbf195472ed7 /doc/cuirass.texi
parent7cee071e503ae2c68ba49dc494a4db759e1dd555 (diff)
downloadcuirass-e550cb6a9a9c8b42f9be88cc49d7b72232097045.tar
cuirass-e550cb6a9a9c8b42f9be88cc49d7b72232097045.tar.gz
cuirass: Store new information in database to prepare new HTTP API
integration. * bin/evaluate.in (fill-job): New procedure. (main): Use it to fill informations (nix-name, system) that will later be added to database. * doc/cuirass.texi (Database)[Derivation]: Add system and nix_name fields. (Database)[Builds]: Add id, status, timestamp, starttime and stoptime fields. Remove output field. (Database)[Outputs]: New table describing the build outputs. * src/cuirass/base.scm (build-packages): Add new fields to build object before adding it to database. * src/cuirass/database.scm (db-get-build, db-get-builds): New procedures to get a build by id from database and a list of builds using filter parameters respectively. * src/schema.sql (Outputs) : New table. (Derivations): Add system and nix_name columns. (Builds): Remove output column and add id, status, timestamp, starttime and stoptime columns.
Diffstat (limited to 'doc/cuirass.texi')
-rw-r--r--doc/cuirass.texi52
1 files changed, 48 insertions, 4 deletions
diff --git a/doc/cuirass.texi b/doc/cuirass.texi
index 2899ffb..add13e0 100644
--- a/doc/cuirass.texi
+++ b/doc/cuirass.texi
@@ -10,7 +10,8 @@
This manual is for Cuirass version @value{VERSION}, a build automation
server.
-Copyright @copyright{} 2016, 2017 Mathieu Lirzin
+Copyright @copyright{} 2016, 2017 Mathieu Lirzin@*
+Copyright @copyright{} 2017 Mathieu Othacehe
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -312,6 +313,14 @@ This field holds the @code{id} of an evaluation from the
@item job_name
This text field holds the name of the job.
+
+@item system
+This text field holds the system name of the derivation.
+
+@item nix_name
+This text field holds the name of the derivation ---e.g.,
+@code{coreutils-8.24}.
+
@end table
@section Builds
@@ -322,6 +331,9 @@ that builds are not in a one to one relationship with derivations in
order to keep track of non-deterministic compilations.
@table @code
+@item id
+This is an automatically incrementing numeric identifier.
+
@item derivation
This text field holds the absolute name of the derivation file that
resulted in this build.
@@ -334,9 +346,41 @@ belongs.
@item log
This text field holds the absolute file name of the build log file.
-@item output
-This text field holds the absolute directory name of the build output or
-@code{NULL} if the build failed.
+@item status
+This integer field holds the build status of the derivation.
+
+@item timestamp
+This integer field holds a timestamp taken at build creation time.
+
+@item starttime
+This integer field holds a timestamp taken at build start time.
+Currently, it has the same value as the @code{timestamp} above.
+
+@item stoptime
+This integer field holds a timestamp taken at build stop time.
+Currently, it has the same value as the @code{timestamp} above.
+
+@end table
+
+@section Outputs
+@cindex outputs, database
+
+This table keep tracks for every eventual build outputs. Each build
+stored in @code{Builds} table may have zero (if it has failed), one or
+multiple outputs.
+
+@table @code
+@item build
+This field holds the @code{id} of a build from the
+@code{Builds} table.
+
+@item name
+This text field holds the name of the output.
+
+@item path
+This text field holds the path of the output.
+
+@end table
@end table