Describe tracing option

askimed · Aug 26, 2022 · e4a413a · e4a413a
1 parent d41327c
commit e4a413a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/cli/test.md b/docs/cli/test.md
@@ -13,6 +13,9 @@ nf-test test [<NEXTFLOW_FILES>]
 #### `--debug`
 The debug parameter prints out all available output channels which can be accessed in the `then` clause.
 
+#### `--without-trace`
+The Linux tool `procps` is required to run Nextflow tracing. In case your container does not support this tool, you can also run nf-test without tracing. Please note that the `workflow.trace` are not available when running it with this flag.
+
 ## Examples
 
 Run all tests:

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -19,6 +19,8 @@ config {
     configFile "tests/nextflow.config"
     // run all test with the defined docker profile from the main nextflow.config
     profile "docker"
+    // disable tracing options in case container does not include `procps` Linux tool.
+    withTrace = false
 
 }
 ```