Skip to content

Commit e26d2f4

Browse files
authored
Follow up on generate_dsym docs (#2599)
1 parent 332ed7e commit e26d2f4

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

R/install.R

+7-3
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@
4141
#' installed alongside the library. This file contains source and line
4242
#' information that allows a debugger to step through original sources.
4343
#'
44-
#' Note that since `install()` operates from a temporary directory, the source
45-
#' paths will point to dangling locations. You will need to remap these paths
46-
#' to the actual sources on your disk, e.g. with lldb:
44+
#' Note that when `build` is set to `TRUE`, `install()` operates from a
45+
#' temporary directory which causes the source paths to point to dangling
46+
#' locations. You will need to remap these paths to the actual sources on your
47+
#' disk, e.g. with lldb:
4748
#'
4849
#' ```
4950
#' # Get information about the dangling temporary path for a function in your
@@ -53,6 +54,9 @@
5354
#' # Remap the dangling location to the actual package path
5455
#' settings set target.source-map /private/tmp/Rtmpnl5XgE/R.INSTALLe5133dcc3211/mypackage /path/to/mypackage
5556
#' ```
57+
#'
58+
#' To avoid this, set `build` to `FALSE` to install directly from the source
59+
#' location instead of a "built" package tarball.
5660
#' @param ... additional arguments passed to [remotes::install_deps()]
5761
#' when installing dependencies.
5862
#' @family package installation

man/install.Rd

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

0 commit comments

Comments
 (0)