[Rcpp-commits] r4203 - in pkg/Rcpp: . man

[noreply at r-forge.r-project.org]

Author: jjallaire
Date: 2013-01-13 12:42:47 +0100 (Sun, 13 Jan 2013)
New Revision: 4203

Modified:
   pkg/Rcpp/ChangeLog
   pkg/Rcpp/TODO
   pkg/Rcpp/man/pluginsAttribute.Rd
Log:
clarify which fields of plugin are used by sourceCpp

Modified: pkg/Rcpp/ChangeLog
===================================================================
--- pkg/Rcpp/ChangeLog	2013-01-13 11:31:22 UTC (rev 4202)
+++ pkg/Rcpp/ChangeLog	2013-01-13 11:42:47 UTC (rev 4203)
@@ -1,6 +1,8 @@
 2014-01-13  JJ Allaire <jj at rstudio.org>
 
         * R/Attributes.R: use plugin includes in cppFunction
+        * man/pluginsAttribute.Rd: clarify which fields of plugin are
+        used by sourceCpp
 
 2014-01-12  JJ Allaire <jj at rstudio.org>
 

Modified: pkg/Rcpp/TODO
===================================================================
--- pkg/Rcpp/TODO	2013-01-13 11:31:22 UTC (rev 4202)
+++ pkg/Rcpp/TODO	2013-01-13 11:42:47 UTC (rev 4203)
@@ -116,10 +116,6 @@
 
     o   Warn user if Rpp library or source file has spaces in it's path
 
-    o   Some mechanism for custom compliation flags and dependencies that
-        don't require a pacakge (e.g. calling inline plugins directly, 
-        setting cxxflags directly, import via pkgconfig, etc.)
-
     o   Use source directory as build working directory so that a) error
         messages refer to the correct file; and b) local includes work
 

Modified: pkg/Rcpp/man/pluginsAttribute.Rd
===================================================================
--- pkg/Rcpp/man/pluginsAttribute.Rd	2013-01-13 11:31:22 UTC (rev 4202)
+++ pkg/Rcpp/man/pluginsAttribute.Rd	2013-01-13 11:42:47 UTC (rev 4203)
@@ -18,10 +18,19 @@
 }
 
 \details{
-    Note that plugins must be registered using the \code{\link{registerPlugin}}
-    function. \pkg{Rcpp} also includes a built-in \code{cpp11} plugin that
-    adds the flag required to enable \code{C++11} features in the compiler.
+Plugins must be registered using the \code{\link{registerPlugin}}
+function. 
+
+When included within a \code{\link{sourceCpp}} translation unit,
+the configuration-related fields of the plugin (e.g. \code{env} and 
+\code{LinkingTo}) are utilized, however the code-generation fields
+(e.g. \code{includes} and \code{body}) are not.
+
 }
+\note{
+\pkg{Rcpp} includes a built-in \code{cpp11} plugin that
+adds the flags required to enable \code{C++11} features in the compiler.
+}
 
 \seealso{
 \code{\link{registerPlugin}}