updated docs with new config parameter

Signed-off-by: tcutts <[email protected]>

Author: tcutts

docs/executor.md

@@ -446,6 +446,10 @@ Nextflow does not provide direct support for SLURM multi-clusters. If you need t
 Some SLURM clusters require memory allocations to be specified with `--mem-per-cpu` instead of `--mem`. You can specify `executor.perCpuMemAllocation = true` in the Nextflow configuration to enable this behavior. Nextflow will automatically compute the memory per CPU for each task (by default 1 CPU is used).
 :::
 
+:::{versionadded} 25.10.0
+Since SLURM 24,`squeue` has supported an `--only-job-state` option which ignores the partition (`-p`) or user (`-u`) filters. You can specify `executor.$slurm.onlyJobState = true` in the Nextflow configuration to enable this behavior; if your SLURM administrator has enabled  `SchedulerParameters=enable_job_state_cache` this should provide a significant performance to nextflow and reduce the load on the SLURM controller.
+:::
+
 (tcs-executor)=
 
 ## TCS

docs/reference/config.md

@@ -715,6 +715,12 @@ The following settings are available:
 : *Used only by the {ref}`slurm-executor` executor.*
 : When `true`, memory allocations for SLURM jobs are specified as `--mem-per-cpu <task.memory / task.cpus>` instead of `--mem <task.memory>`.
 
+`executor.onlyJobState`
+: :::{versionadded} 25.10.0
+  :::
+: *Used only by the {ref}`slurm-executor` executor.*
+: When `true`, job status queries use `squeue --only-job-state` without partition (`-p`) or user (`-u`) filters. This can reduce the load on the SLURM controller, especially if your SLURM administrator has enabled `SchedulerParameters=enable_job_state_cache` in the SLURM configuration - note versions of SLURM prior to 24 do not support this parameter (default: `false`).
+
 `executor.perJobMemLimit`
 : *Used only by the {ref}`lsf-executor` executor.*
 : Enables the *per-job* memory limit mode for LSF jobs.

modules/nextflow/src/main/groovy/nextflow/executor/SlurmExecutor.groovy

@@ -160,7 +160,7 @@ class SlurmExecutor extends AbstractGridExecutor implements TaskArrayExecutor {
 
         final result = ['squeue','--noheader', '-o','%i %t', '-t', 'all']
 
-        if (onlyJobState) {
+        if( onlyJobState ) {
             result << '--only-job-state'
             // -p and -u cannot be used with --only-job-state
             return result

modules/nextflow/src/test/groovy/nextflow/executor/SlurmExecutorTest.groovy

@@ -354,7 +354,7 @@ class SlurmExecutorTest extends Specification {
         then:
         resultNoQueue == ['squeue','--noheader','-o','%i %t','-t','all','-u', usr]
         !resultNoQueue.contains('--only-job-state')
-        
+
         and:
         resultWithQueue == ['squeue','--noheader','-o','%i %t','-t','all','-p','myqueue','-u', usr]
         !resultWithQueue.contains('--only-job-state')