Add a document for introducing the runtime field.

Signed-off-by: Zhang Yale ylzhangah@qq.com --- doc/job/runtime.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 doc/job/runtime.md

diff --git a/doc/job/runtime.md b/doc/job/runtime.md new file mode 100644 index 0000000..c604bfa --- /dev/null +++ b/doc/job/runtime.md @@ -0,0 +1,27 @@ +# runtime + +Meaning: +- Seconds to run before exiting. +- Limit the test's run time in $runtime. + +Usage example: + +```bash +#!/bin/sh +# - runtime +``` + +`runtime` is a parameter of test script. +For any test case needing parameter(s), +need such comment line and follow exactly +the same format `# - parameter`. + +```yaml +runtime: 300s +``` + +```yaml +runtime: 1d +sleep: +``` +