26
26
# ' binary artefacts (like \file{.o}, `.so`) from appearing in your local
27
27
# ' package directory, but is considerably slower, because every compile has
28
28
# ' to start from scratch.
29
+ # '
30
+ # ' One downside of installing from a built tarball is that the package is
31
+ # ' installed from a temporary location. This means that any source references,
32
+ # ' at R level or C/C++ level, will point to dangling locations. The debuggers
33
+ # ' will not be able to find the sources for step-debugging. If you're
34
+ # ' installing the package for development, consider setting `build` to
35
+ # ' `FALSE`.
29
36
# ' @param args An optional character vector of additional command line
30
37
# ' arguments to be passed to `R CMD INSTALL`. This defaults to the
31
38
# ' value of the option `"devtools.install.args"`.
36
43
# ' @param keep_source If `TRUE` will keep the srcrefs from an installed
37
44
# ' package. This is useful for debugging (especially inside of RStudio).
38
45
# ' It defaults to the option `"keep.source.pkgs"`.
39
- # ' @param generate_dsym (macOS only) If `TRUE`, and if the package includes a
40
- # ' native library (a `.so` file), a `dSYM` sidecar file is generated and
41
- # ' installed alongside the library. This file contains source and line
42
- # ' information that allows a debugger to step through original sources.
43
- # '
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:
48
- # '
49
- # ' ```
50
- # ' # Get information about the dangling temporary path for a function in your
51
- # ' # library
52
- # ' image lookup -vn my_function
53
- # '
54
- # ' # Remap the dangling location to the actual package path
55
- # ' settings set target.source-map /private/tmp/Rtmpnl5XgE/R.INSTALLe5133dcc3211/mypackage /path/to/mypackage
56
- # ' ```
57
- # '
58
- # ' To avoid this, set `build` to `FALSE` to install directly from the source
59
- # ' location instead of a "built" package tarball.
60
46
# ' @param ... additional arguments passed to [remotes::install_deps()]
61
47
# ' when installing dependencies.
62
48
# ' @family package installation
@@ -71,7 +57,6 @@ install <-
71
57
build_vignettes = FALSE ,
72
58
keep_source = getOption(" keep.source.pkgs" ),
73
59
force = FALSE ,
74
- generate_dsym = TRUE ,
75
60
... ) {
76
61
pkg <- as.package(pkg )
77
62
@@ -92,7 +77,6 @@ install <-
92
77
93
78
opts <- c(
94
79
if (keep_source ) " --with-keep.source" ,
95
- if (is_macos && generate_dsym ) " --dsym" ,
96
80
" --install-tests"
97
81
)
98
82
if (quick ) {
0 commit comments