Document behavior of RcppParallelFlags

krlmlr · krlmlr · commit f1c7fd70fa83 · 2020-09-09T04:22:49.000+02:00
diff --git a/man/RcppParallelFlags.Rd b/man/RcppParallelFlags.Rd
@@ -19,6 +19,10 @@ These functions are typically called from \code{Makevars} as follows:
 
 \code{PKG_LIBS += $(shell "${R_HOME}/bin/Rscript" -e "RcppParallel::LdFlags()")}
 
+On Windows, the flags ensure that the package links with the built-in TBB library.
+On Linux and macOS, the output is empty, because TBB is loaded dynamically.
+To ensure portability, load \pkg{RcppParallel} before loading your package, e.g. by including \code{importFrom(RcppParallel, RcppParallelLibs)} in your \code{NAMESPACE} file.
+See \url{https://github.com/RcppCore/RcppParallel/issues/129} for details.
 }
 
 \value{

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,10 @@ These functions are typically called from \code{Makevars} as follows:`
`19`	`19`
`20`	`20`	`\code{PKG_LIBS += $(shell "${R_HOME}/bin/Rscript" -e "RcppParallel::LdFlags()")}`
`21`	`21`
	`22`	`+On Windows, the flags ensure that the package links with the built-in TBB library.`
	`23`	`+On Linux and macOS, the output is empty, because TBB is loaded dynamically.`
	`24`	`+To ensure portability, load \pkg{RcppParallel} before loading your package, e.g. by including \code{importFrom(RcppParallel, RcppParallelLibs)} in your \code{NAMESPACE} file.`
	`25`	`+See \url{https://github.com/RcppCore/RcppParallel/issues/129} for details.`
`22`	`26`	`}`
`23`	`27`
`24`	`28`	`\value{`