Skip to content

Commit 4392c60

Browse files
HELP: demote Section 'Options moved to the 'parallelly' package' to end of 'options' page
1 parent 3c45a16 commit 4392c60

File tree

3 files changed

+46
-48
lines changed

3 files changed

+46
-48
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Package: future
2-
Version: 1.49.0-9019
2+
Version: 1.49.0-9020
33
Title: Unified Parallel and Distributed Processing in R for Everyone
44
Depends:
55
R (>= 3.2.0)

R/utils-options.R

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,6 @@
2222
#' f <- future({ expr }) ## Launch a future with large objects
2323
#' ```
2424
#'
25-
#' @section Settings moved to the 'parallelly' package:
26-
#' Several functions have been moved to the \pkg{parallelly} package:
27-
#'
28-
#' * [parallelly::availableCores()]
29-
#' * [parallelly::availableWorkers()]
30-
#' * [parallelly::makeClusterMPI()]
31-
#' * [parallelly::makeClusterPSOCK()]
32-
#' * [parallelly::makeNodePSOCK()]
33-
#' * [parallelly::supportsMulticore()]
34-
#'
35-
#' The options and environment variables controlling those have been adjusted
36-
#' accordingly to have different prefixes.
37-
#' For example, option \option{future.fork.enable} has been renamed to
38-
#' \option{parallelly.fork.enable} and the corresponding environment variable
39-
#' \env{R_FUTURE_FORK_ENABLE} has been renamed to
40-
#' \env{R_PARALLELLY_FORK_ENABLE}.
41-
#' For backward compatibility reasons, the \pkg{parallelly} package will
42-
#' support both versions for a long foreseeable time.
43-
#' See the [parallelly::parallelly.options] page for the settings.
44-
#'
4525
#' @section Options for controlling futures:
4626
#' \describe{
4727
#' \item{\option{future.plan}:}{(character string or future function) Default future backend used unless otherwise specified via [plan()]. This will also be the future plan set when calling `plan("default")`. If not specified, this option may be set when the \pkg{future} package is _loaded_ if command-line option `--parallel=ncores` (short `-p ncores`) is specified; if `ncores > 1`, then option \option{future.plan} is set to `multisession` otherwise `sequential` (in addition to option \option{mc.cores} being set to `ncores`, if `ncores >= 1`). (Default: `sequential`)}
@@ -165,8 +145,6 @@
165145
#' \item{\option{future.output.windows.reencode}:}{(logical) Enable or disable re-encoding of UTF-8 symbols that were incorrectly encoded while captured. In R (< 4.2.0) and on older versions of MS Windows, R cannot capture UTF-8 symbols as-is when they are captured from the standard output. For examples, a UTF-8 check mark symbol (`"\u2713"`) would be relayed as `"<U+2713>"` (a string with eight ASCII characters). Setting this option to `TRUE` will cause `value()` to attempt to recover the intended UTF-8 symbols from `<U+nnnn>` string components, if, and only if, the string was captured by a future resolved on MS Windows. (Default: `TRUE`)}
166146
#' }
167147
#'
168-
#' See also [parallelly::parallelly.options].
169-
#'
170148
#'
171149
#' @section Options for demos:
172150
#' \describe{
@@ -202,6 +180,28 @@
202180
#' Similarly, if `R_FUTURE_GLOBALS_MAXSIZE="50000000"`, then option
203181
#' \option{future.globals.maxSize} is set to `50000000` (numeric).
204182
#'
183+
#'
184+
#' @section Options moved to the 'parallelly' package:
185+
#' Several functions have been moved to the \pkg{parallelly} package:
186+
#'
187+
#' * [parallelly::availableCores()]
188+
#' * [parallelly::availableWorkers()]
189+
#' * [parallelly::makeClusterMPI()]
190+
#' * [parallelly::makeClusterPSOCK()]
191+
#' * [parallelly::makeNodePSOCK()]
192+
#' * [parallelly::supportsMulticore()]
193+
#'
194+
#' The options and environment variables controlling those have been adjusted
195+
#' accordingly to have different prefixes.
196+
#' For example, option \option{future.fork.enable} has been renamed to
197+
#' \option{parallelly.fork.enable} and the corresponding environment variable
198+
#' \env{R_FUTURE_FORK_ENABLE} has been renamed to
199+
#' \env{R_PARALLELLY_FORK_ENABLE}.
200+
#' For backward compatibility reasons, the \pkg{parallelly} package will
201+
#' support both versions for a long foreseeable time.
202+
#' See the [parallelly::parallelly.options] page for the settings.
203+
#'
204+
#'
205205
#' @examples
206206
#' # Allow at most 5 MB globals per futures
207207
#' options(future.globals.maxSize = 5e6)

man/zzz-future.options.Rd

Lines changed: 23 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)