Document issues with C++ code on macOS (#10)

and how to use `check_rTRNG_linking()` in general to explicitly check.

R/rTRNG-package.R

@@ -45,6 +45,12 @@
 #'       \code{importFrom(rTRNG, TRNG.Version)} in the NAMESPACE file, and
 #'       setting relevant linker flags (via \code{\link[rTRNG]{LdFlags}}) and
 #'       C++11 compilation (\code{CXX_STD = CXX11}) in Makevars[.win].
+#'     \item
+#'       Note that C++ code using the TRNG library (sourced via
+#'       \code{Rcpp::sourceCpp} or part of an \R package) might fail on certain
+#'       systems due issues with building and linking against \pkg{rTRNG}. This
+#'       is typically the case for  macOS, and can be in general checked using
+#'       \code{\link[rTRNG]{check_rTRNG_linking}}.
 #'     }
 #' }
 #' See the package vignettes (\code{browseVignettes("rTRNG")}) for an overview

README.Rmd

@@ -156,7 +156,6 @@ x_serial <- rnorm_trng(1e5L)
 identical(x_serial, x_parallel)
 ```
 
-
 ### Use TRNG from standalone C++
 
 The TRNG C++ library is made available by **rTRNG** to standalone C++ code
@@ -199,3 +198,13 @@ Creating an R package with C++ code using the TRNG library and headers through
     - Makevars: `PKG_LIBS += $(shell ${R_HOME}/bin/Rscript -e "rTRNG::LdFlags()")`
     - Makevars.win: `PKG_LIBS += $(shell "${R_HOME}/bin${R_ARCH_BIN}/Rscript.exe" -e "rTRNG::LdFlags()")`
 
+### Note about C++ code on macOS
+
+C++ code using the TRNG library (sourced via `Rcpp::sourceCpp` or part of an R
+package) might fail on certain systems due issues with building and linking
+against **rTRNG**. This is typically the case for  **macOS**, and can be in
+general checked by running
+
+```{r check-linking, eval=FALSE}
+rTRNG::check_rTRNG_linking()
+```

README.md

@@ -190,3 +190,14 @@ through **rTRNG** is achieved by
         "rTRNG::LdFlags()")`
       - Makevars.win: `PKG_LIBS += $(shell
         "${R_HOME}/bin${R_ARCH_BIN}/Rscript.exe" -e "rTRNG::LdFlags()")`
+
+### Note about C++ code on macOS
+
+C++ code using the TRNG library (sourced via `Rcpp::sourceCpp` or part
+of an R package) might fail on certain systems due issues with building
+and linking against **rTRNG**. This is typically the case for **macOS**,
+and can be in general checked by running
+
+``` r
+rTRNG::check_rTRNG_linking()
+```

vignettes/rTRNG.Rmd

@@ -149,3 +149,15 @@ Creating an R package with C++ code using the TRNG library and headers through
 - setting the relevant linker flags in Makevars[.win] via `rTRNG::LdFlags()`
     - Makevars: `PKG_LIBS += $(shell ${R_HOME}/bin/Rscript -e "rTRNG::LdFlags()")`
     - Makevars.win: `PKG_LIBS += $(shell "${R_HOME}/bin${R_ARCH_BIN}/Rscript.exe" -e "rTRNG::LdFlags()")`
+
+
+### Note about C++ code on macOS
+
+C++ code using the TRNG library (sourced via `Rcpp::sourceCpp` or part of an R
+package) might fail on certain systems due issues with building and linking
+against **rTRNG**. This is typically the case for  **macOS**, and can be in
+general checked by running
+
+```{r check-linking, eval=FALSE}
+rTRNG::check_rTRNG_linking()
+```