Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc section on debug compiler flags #303

Merged
merged 2 commits into from
Nov 4, 2024
Merged

Add doc section on debug compiler flags #303

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6845c8b
Add doc section on debug compiler flags.
mcol Nov 4, 2024
d3f1c0a
Reword according to Lionel's suggestion.
mcol Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion R/load.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,16 @@
#' behavior when loading an installed package with [library()], and can
#' be useful for checking for missing exports.
#'
#' # Controlling the debug compiler flags
#'
#' `load_all()` delegates to [pkgbuild::compile_dll()] to perform the actual
#' compilation, during which by default some debug compiler flags are
#' appended. If this is undesired (for example, if you would like to produce
#' an optimized build), you can opt out by setting the `pkg.build_extra_flags`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#' appended. If this is undesired (for example, if you would like to produce
#' an optimized build), you can opt out by setting the `pkg.build_extra_flags`
#' appended. If you would like to produce an optimized build instead),
#' you can opt out by setting the `pkg.build_extra_flags`

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion! I didn't apply it directly for a mismatched bracket. :)

#' option or the `PKG_BUILD_EXTRA_FLAGS` environment variable to `FALSE`.
#' For further details see the Details section in [pkgbuild::compile_dll()].
#'
#'
#' @param path Path to a package, or within a package.
#' @param reset `r lifecycle::badge("deprecated")` This is no longer supported
#' because preserving the namespace requires unlocking its environment, which
Expand Down Expand Up @@ -122,7 +132,7 @@
warn_conflicts = TRUE) {
if (!isTRUE(reset)) {
lifecycle::deprecate_warn(
when = "1.3.5",
when = "1.3.5",

Check warning on line 135 in R/load.R

View check run for this annotation

Codecov / codecov/patch

R/load.R#L135 

Added line #L135 was not covered by tests
what = "load_all(reset)",
details = "`reset = FALSE` is no longer supported."
)
Expand Down
9 changes: 9 additions & 0 deletions man/load_all.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading