From 67e8dea61a160921206501378055aaed4d33efa1 Mon Sep 17 00:00:00 2001
From: Nikolai Kondrashov <Nikolai.Kondrashov@redhat.com>
Date: Mon, 2 Jul 2018 19:33:17 +0300
Subject: [PATCH] Add reporting design

---
 reporting_design.md | 130 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 130 insertions(+)
 create mode 100644 reporting_design.md

diff --git a/reporting_design.md b/reporting_design.md
new file mode 100644
index 0000000..b2f1217
--- /dev/null
+++ b/reporting_design.md
@@ -0,0 +1,130 @@
+Skt data flow and reporting design
+==================================
+
+Each skt stage command has:
+
+* Two inputs:
+    * Command-line options
+        * One of which may be specifying a configuration file containing
+          some command-line option values. The file cannot be used to
+          specify anything, which cannot be set with command-line options.
+          Command-line options following this option override values in
+          the file. This option can have a default, such as ~/.skt.yaml
+    * Input directory
+* Two outputs:
+    * Output directory
+    * Exit status summarizing the produced contents of the output
+      directory. I.e. the output directory contains all the data encoded
+      in the exit status.
+
+Among skt options are: input directory and output directory
+input directory by default is current directory
+output directory by default is input directory
+
+None of the different skt stage commands have output file names named the
+same, so they cannot step onto each other's toes. However, re-running the same
+skt stage command replaces existing files completely. E.g. it will need to
+remove all files that might have been created by the previous run of the same
+command, before starting adding its own, so the output file set is not
+inconsistent.
+
+Output of one skt stage command is a superset of an input to the next stage
+command. Note: input and output don't have to be in the same directory. I.e.
+output of one stage can be input to multiple runs of the next stage, e.g. with
+different command-line options.
+
+A stage command shouldn't require repeating the option passed to any of the
+previous stages (i.e. those should be encoded in the stage's output), but may
+allow overriding them.
+
+In essence, an output of a stage is an independent entity, using it should not
+require providing any other input to skt.
+
+Each command has inputs and outputs documented explicitly, so they could be
+used both by skt and other programs, however some parts might be defined
+opaque for use by skt only. Specific command descriptions follow.
+
+Merge
+-----
+
+Produce a source tree with patches applied.
+
+### Inputs
+
+#### Command-line options
+
+* git repository to fetch from
+* git reference from the repository to base patches on
+* git fetch depth
+* what to merge on top (in order of specification),
+  arbitrary combination and number:
+    * git reference from the same repository
+    * URL of a patch mbox (including file:// scheme)
+
+#### Input directory
+
+No files expected
+
+### Outputs
+
+#### Output directory
+
+* "source" directory containing what is required as the input by the
+  "Build" command.
+* "merge.log" - diagnostics output of the merging attempt.
+* "merge.done" - empty file, created only if merge stage succeeded
+
+#### Exit status
+Zero on success, one if "merge.done" is missing, two and greater if other
+failure occurred.
+
+Build
+-----
+
+Produce a kernel tarball.
+
+### Inputs
+
+#### Command-line options
+
+* Extra make options
+* Configuration type: "tinyconfig", "rh-configs" (works only if Makefile
+  supports "rh-configs" target), other configuration-generating target
+  supported by the Makefile in "source".
+* Shell glob, relative to the "source" root, matching a configuration file
+  inside the "source" tree to use. Only valid if "rh-configs"
+  configuration type is used.
+* Kernel configuration file to use as the base. Exclusive with
+  "tinyconfig" and "rh-configs" configuration types.
+
+TODO: Figure out a better arrangement, so values, not options are exclusive.
+TODO: See if we can define allowed configuration types more strictly.
+
+#### Input directory
+
+* "source" directory containing the source of the "kernel", must contain
+  the following (TODO: make sure everything we need is listed):
+    * Makefile
+        * Must support the following targets (TODO: detail all targets):
+            * "mrproper" - cleanup the tree
+            * "tinyconfig" - generate minimum kernel configuration
+            * "kernelrelease" - output kernel version
+            * "targz-pkg" - build kernel tarball
+        * May support the following targets:
+            * "rh-configs" - generate a set of configuration files
+              somewhere in the build directory
+            * other targets generating kernel configuration
+* "merge.done" - empty file
+
+### Outputs
+
+#### Output directory
+
+* "kernel.tar.gz" - the built kernel tarball
+* "kernel.config" - the used kernel configuration
+* "build.log" - diagnostics output of the building stage
+* "build.done" - empty file, created only if build stage succeeded
+
+#### Exit status
+Zero on success, one if "build.done" is missing, two and greater if other
+failure occurred.