Skip to content

Commit d0fd375

Browse files
authored
Document bucketDir config option (#6191) [ci skip]
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
1 parent 7bfb935 commit d0fd375

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

docs/reference/config.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ This page lists all of the available settings in the {ref}`Nextflow configuratio
88

99
## Unscoped options
1010

11+
`bucketDir`
12+
: The remote work directory used by hybrid workflows. Equivalent to the `-bucket-dir` option of the `run` command.
13+
1114
`cleanup`
1215
: If `true`, on a successful completion of a run all files in *work* directory are automatically deleted.
1316

modules/nextflow/src/main/groovy/nextflow/config/ConfigValidator.groovy

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ class ConfigValidator {
3636
* Hidden options added by ConfigBuilder
3737
*/
3838
private static final List<String> hiddenOptions = List.of(
39-
'bucketDir',
4039
'cacheable',
4140
'dumpChannels',
4241
'libDir',

modules/nf-lang/src/main/java/nextflow/config/scopes/Config.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ public class Config implements ConfigScope {
2525

2626
// OPTIONS
2727

28+
@ConfigOption
29+
@Description("""
30+
The remote work directory used by hybrid workflows. Equivalent to the `-bucket-dir` option of the `run` command.
31+
""")
32+
public Path bucketDir;
33+
2834
@ConfigOption
2935
@Description("""
3036
If `true`, on a successful completion of a run all files in *work* directory are automatically deleted.

0 commit comments

Comments
 (0)