From 9fd9c7e19dd2a8dcf386811dc09bd13aa322ab35 Mon Sep 17 00:00:00 2001 From: Jonathan Shook Date: Fri, 19 Nov 2021 17:57:16 -0600 Subject: [PATCH] document stopping multiple activities --- .../resources/docs-for-nb/reference/cli_scripting.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/engine-docs/src/main/resources/docs-for-nb/reference/cli_scripting.md b/engine-docs/src/main/resources/docs-for-nb/reference/cli_scripting.md index 1cd384269..f3a9c0b99 100644 --- a/engine-docs/src/main/resources/docs-for-nb/reference/cli_scripting.md +++ b/engine-docs/src/main/resources/docs-for-nb/reference/cli_scripting.md @@ -53,6 +53,15 @@ activities with a meaningful alias. Stop an activity with the given alias. This is synchronous, and causes the scenario to pause until the activity is stopped. This means that all threads for the activity have completed and signalled that they're in a stopped state. +You can stop a single activity alias, or any which match a regex pattern. If the value provided +contains spaces, semicolons or commas, then it is split into words and each word is used as if +the stop command had been called on it in turn. + +If the alias name you supply follows matches the regular expression `[a-zA-Z_][a-zA-Z0-9_.]*`, i.e. an alphanumeric +name with dots or underscores and no leading digit, then it is taken as a literal name and only +matches the same literal alias. However, if there are any other characters, it is presumed to be +a regular expression and matched as such against all currently running activities. + ### await an activity `await ` @@ -87,7 +96,8 @@ Add the contents of the named file to the scenario script buffer. `fragment