diff --git a/R/install.R b/R/install.R index df1a22e3a..f165f82d1 100644 --- a/R/install.R +++ b/R/install.R @@ -41,9 +41,10 @@ #' installed alongside the library. This file contains source and line #' information that allows a debugger to step through original sources. #' -#' Note that since `install()` operates from a temporary directory, the source -#' paths will point to dangling locations. You will need to remap these paths -#' to the actual sources on your disk, e.g. with lldb: +#' Note that when `build` is set to `TRUE`, `install()` operates from a +#' temporary directory which causes the source paths to point to dangling +#' locations. You will need to remap these paths to the actual sources on your +#' disk, e.g. with lldb: #' #' ``` #' # Get information about the dangling temporary path for a function in your @@ -53,6 +54,9 @@ #' # Remap the dangling location to the actual package path #' settings set target.source-map /private/tmp/Rtmpnl5XgE/R.INSTALLe5133dcc3211/mypackage /path/to/mypackage #' ``` +#' +#' To avoid this, set `build` to `FALSE` to install directly from the source +#' location instead of a "built" package tarball. #' @param ... additional arguments passed to [remotes::install_deps()] #' when installing dependencies. #' @family package installation diff --git a/man/install.Rd b/man/install.Rd index f1cfe908c..7aef39175 100644 --- a/man/install.Rd +++ b/man/install.Rd @@ -84,9 +84,10 @@ native library (a \code{.so} file), a \code{dSYM} sidecar file is generated and installed alongside the library. This file contains source and line information that allows a debugger to step through original sources. -Note that since \code{install()} operates from a temporary directory, the source -paths will point to dangling locations. You will need to remap these paths -to the actual sources on your disk, e.g. with lldb: +Note that when \code{build} is set to \code{TRUE}, \code{install()} operates from a +temporary directory which causes the source paths to point to dangling +locations. You will need to remap these paths to the actual sources on your +disk, e.g. with lldb: \if{html}{\out{
}}\preformatted{# Get information about the dangling temporary path for a function in your # library @@ -94,7 +95,10 @@ image lookup -vn my_function # Remap the dangling location to the actual package path settings set target.source-map /private/tmp/Rtmpnl5XgE/R.INSTALLe5133dcc3211/mypackage /path/to/mypackage -}\if{html}{\out{
}}} +}\if{html}{\out{}} + +To avoid this, set \code{build} to \code{FALSE} to install directly from the source +location instead of a "built" package tarball.} \item{...}{additional arguments passed to \code{\link[remotes:install_deps]{remotes::install_deps()}} when installing dependencies.}