Skip to content
This repository has been archived by the owner on Sep 23, 2024. It is now read-only.

Commit

Permalink
reporting_design: Add report inclusion
Browse files Browse the repository at this point in the history
  • Loading branch information
spbnick committed Jul 11, 2018
1 parent bbd7130 commit a97a826
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions reporting_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,34 @@ e.g. references to e-mail attachments or hyperlinks.

The syntax of such references is `{<PATH>}`, where `<PATH>` is the path to the
output file to include into the report, relative to the directory the report
file is in. To provide an option to include literal curly braces into reports,
any characters preceded by a backslash would be copied by sktm into the
summarized report literally, without interpretation.
file is in.

The text can refer to other reports to be included directly into the resulting
report text. Such included reports are given a name, which is used to
"namespace" all the output files they refer to, by e.g. prepending it to their
filenames. The syntax of such references is `<<NAME>:<PATH>>`, where `<NAME>`
is the report name (consisting of alphanumeric characters and underscores, can
be empty for "root" namespace), and `<PATH>` is the path to the report to
include, relative to the directory the including report text resides in.

For example, the following report:

x86_64 build failed:
<x86_64:x86_64/build.report>

is referring to another report located in `x86_64/build.report`, and is naming
it `x86_64`. So, if that report was:

See {build.log.gz} for details.

then e.g. the resulting e-mail would read:

x86_64 build failed:
See the attached x86_64_build.log.gz for details.

To provide the option to include literal curly braces or angle brackets into
reports, any characters preceded by a backslash would be copied by sktm into
the summarized report literally, without interpretation.

##### Result status
Each stage output includes a status file, which is set executable and contains
Expand Down

0 comments on commit a97a826

Please sign in to comment.