Skip to content

Commit d10172c

Browse files
authored
Add doc section on debug compiler flags (#303)
1 parent 96d1a74 commit d10172c

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

R/load.R

+11-1
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,16 @@
6464
#' behavior when loading an installed package with [library()], and can
6565
#' be useful for checking for missing exports.
6666
#'
67+
#' # Controlling the debug compiler flags
68+
#'
69+
#' `load_all()` delegates to [pkgbuild::compile_dll()] to perform the actual
70+
#' compilation, during which by default some debug compiler flags are
71+
#' appended. If you would like to produce an optimized build instead,
72+
#' you can opt out by setting the `pkg.build_extra_flags`
73+
#' option or the `PKG_BUILD_EXTRA_FLAGS` environment variable to `FALSE`.
74+
#' For further details see the Details section in [pkgbuild::compile_dll()].
75+
#'
76+
#'
6777
#' @param path Path to a package, or within a package.
6878
#' @param reset `r lifecycle::badge("deprecated")` This is no longer supported
6979
#' because preserving the namespace requires unlocking its environment, which
@@ -122,7 +132,7 @@ load_all <- function(path = ".",
122132
warn_conflicts = TRUE) {
123133
if (!isTRUE(reset)) {
124134
lifecycle::deprecate_warn(
125-
when = "1.3.5",
135+
when = "1.3.5",
126136
what = "load_all(reset)",
127137
details = "`reset = FALSE` is no longer supported."
128138
)

man/load_all.Rd

+9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)