path: root/doc/results-files-report-example.mdoc
diff options
Diffstat (limited to 'doc/results-files-report-example.mdoc')
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/results-files-report-example.mdoc b/doc/results-files-report-example.mdoc
new file mode 100644
index 000000000000..74ef99f16da4
--- /dev/null
+++ b/doc/results-files-report-example.mdoc
@@ -0,0 +1,32 @@
+.Ss Workflow with results files
+If one runs the following command twice in a row:
+.Bd -literal -offset indent
+kyua test -k /usr/tests/Kyuafile
+the two executions will generate two different files with names like:
+.Bd -literal -offset indent
+Taking advantage of the default naming scheme, the following commands would all
+generate a report for the results of the
+.Em latest
+execution of the test suite:
+.Bd -literal -offset indent
+cd /usr/tests && kyua __REPORT_COMMAND__
+cd /usr/tests && kyua __REPORT_COMMAND__ --results-file=LATEST
+kyua __REPORT_COMMAND__ --results-file=/usr/tests
+kyua __REPORT_COMMAND__ --results-file=usr_tests
+kyua __REPORT_COMMAND__ --results-file=usr_tests.20140731-151730-997451
+But it is also possible to explicitly load data for older runs or from
+explicitly-named files:
+.Bd -literal -offset indent
+kyua __REPORT_COMMAND__ \\
+ --results-file=usr_tests.20140731-150500-196784
+kyua __REPORT_COMMAND__ \\
+ --results-file=~/.kyua/store/results.usr_tests.20140731-150500-196784.db