Skip to content

Clarify clean_doc build documentation #222

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

Closed
LeonidasZhak wants to merge 1 commit into from
Closed

Clarify clean_doc build documentation #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# pkgbuild (development version)

* The `build()` documentation now describes the `clean_doc = FALSE` and
non-interactive `clean_doc = NULL` behavior (#187).

* `needs_compile()` now ignores `.gcov` code coverage files.

# pkgbuild 1.4.8
Expand Down
11 changes: 6 additions & 5 deletions R/build.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,12 @@
#' `tools::package_native_routine_registration_skeleton()` before building
#' the package. It is ignored if package does not need compilation.
#' @param clean_doc If `TRUE`, clean the files in `inst/doc` before building
#' the package. If `NULL` and the `Config/build/clean-inst-doc` entry is
#' present in `DESCRIPTION`, then that is used. Otherwise, if `NULL`,
#' and interactive, ask to remove the files prior to cleaning. In most
#' cases cleaning the files is the correct behavior to avoid stale
#' vignette outputs in the built package.
#' the package. If `FALSE`, leave `inst/doc` unchanged. If `NULL` and the
#' `Config/build/clean-inst-doc` entry is present in `DESCRIPTION`, then that
#' value is used. Otherwise, if `NULL` and interactive, ask before removing
#' the files; if `NULL` and non-interactive, clean the files. In most cases
#' cleaning the files is the correct behavior to avoid stale vignette outputs
#' in the built package.
#' @export
#' @return a string giving the location (including file name) of the built
#' package
Expand Down
11 changes: 6 additions & 5 deletions man/build.Rd
View file
Open in desktop

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

Loading