|
21 | 21 | #' Devtools does its best to set up an environment that combines best practices
|
22 | 22 | #' with how check works on CRAN. This includes:
|
23 | 23 | #'
|
24 |
| -#' \itemize{ |
| 24 | +#' * The standard environment variables set by devtools: |
| 25 | +#' [r_env_vars()]. Of particular note for package tests is the `NOT_CRAN` env |
| 26 | +#' var, which lets you know that your tests are running somewhere other than |
| 27 | +#' CRAN, and hence can take a reasonable amount of time. |
25 | 28 | #'
|
26 |
| -#' \item The standard environment variables set by devtools: |
27 |
| -#' [r_env_vars()]. Of particular note for package tests is the |
28 |
| -#' `NOT_CRAN` env var which lets you know that your tests are not |
29 |
| -#' running on CRAN, and hence can take a reasonable amount of time. |
| 29 | +#' * Debugging flags for the compiler, set by |
| 30 | +#' [`compiler_flags(FALSE)`][compiler_flags()]. |
30 | 31 | #'
|
31 |
| -#' \item Debugging flags for the compiler, set by |
32 |
| -#' \code{\link{compiler_flags}(FALSE)}. |
| 32 | +#' * If `aspell` is found, `_R_CHECK_CRAN_INCOMING_USE_ASPELL_` |
| 33 | +#' is set to `TRUE`. If no spell checker is installed, a warning is issued. |
33 | 34 | #'
|
34 |
| -#' \item If `aspell` is found `_R_CHECK_CRAN_INCOMING_USE_ASPELL_` |
35 |
| -#' is set to `TRUE`. If no spell checker is installed, a warning is |
36 |
| -#' issued.) |
37 |
| -#' |
38 |
| -#' \item env vars set by arguments `incoming`, `remote` and |
39 |
| -#' `force_suggests` |
40 |
| -#' } |
| 35 | +#' * Environment variables, controlled by arguments `incoming`, `remote` and |
| 36 | +#' `force_suggests`. |
41 | 37 | #'
|
42 | 38 | #' @return An object containing errors, warnings, notes, and more.
|
43 | 39 | #' @template devtools
|
@@ -175,7 +171,14 @@ can_document <- function(pkg) {
|
175 | 171 | #' @param manual If `FALSE`, don't build and check manual (`--no-manual`).
|
176 | 172 | #' @param env_vars Environment variables set during `R CMD check`
|
177 | 173 | #' @param quiet if `TRUE` suppresses output from this function.
|
178 |
| -#' @inheritParams rcmdcheck::rcmdcheck |
| 174 | +#' @param error_on Whether to throw an error on `R CMD check` failures. Note |
| 175 | +#' that the check is always completed (unless a timeout happens), and the |
| 176 | +#' error is only thrown after completion. |
| 177 | +#' |
| 178 | +#' `error_on` is passed through to [rcmdcheck::rcmdcheck()], which is the |
| 179 | +#' definitive source for what the different values mean. If not specified by |
| 180 | +#' the user, both `check()` and `check_built()` default to `error_on = |
| 181 | +#' "never"` in interactive use and `"warning"` in a non-interactive setting. |
179 | 182 | check_built <- function(path = NULL, cran = TRUE,
|
180 | 183 | remote = FALSE, incoming = remote, force_suggests = FALSE,
|
181 | 184 | run_dont_test = FALSE, manual = FALSE, args = "--timings",
|
|
0 commit comments