Slurm: Add section 'Known issue "Error Future of class BatchtoolsSlurmFuture expired"'

Author: HenrikBengtsson

DESCRIPTION

@@ -32,5 +32,5 @@ URL: https://future.batchtools.futureverse.org, https://github.com/futureverse/f
 BugReports: https://github.com/futureverse/future.batchtools/issues
 Language: en-US
 Encoding: UTF-8
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 Roxygen: list(markdown = TRUE)

R/batchtools_slurm.R

@@ -46,11 +46,40 @@ print.BatchtoolsSlurmFutureBackend <- function(x, ...) {
 #' This template and the built-in [batchtools::makeClusterFunctionsSlurm()]
 #' have been verified to work on a few different Slurm HPC clusters;
 #'
-#'  1. Slurm 21.08.4, Rocky 8 Linux, NFS global filesystem (August 2025)
-#'  2. Slurm 22.05.11, Rocky 8 Linux, NFS global filesystem (August 2025)
+#'  1. Slurm 21.08.4, Rocky Linux 8, NFS global filesystem (August 2025)
+#'  2. Slurm 22.05.11, Rocky Linux 8, NFS global filesystem (August 2025)
 #'  3. Slurm 23.02.6, Ubuntu 24.04 LTS, NFS global filesystem (August 2025)
+#'  4. Slurm 24.11.3, AlmaLinux 9, Lustre global filesystem (September 2025)
 #'
 #'
+#' @section Known issue "Error Future of class BatchtoolsSlurmFuture expired":
+#'
+#' Some users report (e.g. Issue [#74](https://github.com/futureverse/future.batchtools/issues/74), Discussion [#810](https://github.com/futureverse/future/discussions/810))
+#' that they fail to launch futures on their Slurm clusters using
+#' `plan(batchtools_slurm)`. When attempted, these futures fail with an
+#' error on the "future being expired". Specifically, the error received is:
+#' 
+#' ```
+#' Error: Future (<unnamed-1>) of class BatchtoolsSlurmFuture expired, which indicates
+#' that it crashed or was killed. No log output file exist (at the moment)
+#' In addition: Warning messages:
+#' 1: batchtools::waitForJobs(..., timeout = 2592000) returned FALSE
+#' 2: In delete.BatchtoolsFuture(future) :
+#' Will not remove batchtools registry, because the status of the batchtools was
+#' 'error', 'defined', 'expired', 'submitted'
+#' ```
+#'
+#' We suspect this is related to how some Slurm schedulers provision jobs.
+#' But, because I cannot reproduce this on any of the three Slurm clusters
+#' I have access to, it is hard for me to troubleshoot and fix this myself.
+#' So, I need your help to figure this one out. If you get this error, please
+#' get in touch, preferably by opening an issue at
+#' <https://github.com/futureverse/future.batchtools/issues> and share what
+#' version of **future.batchtools** you have installed and what version of
+#' Slurm (`sbatch --version`) your system have. Then we take it from there.
+#' Thank you.
+#' 
+#'
 #' @examplesIf interactive()
 #' library(future)
 #'