[Rcpp-commits] r1857 - in pkg/Rcpp: inst man

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

Author: romain
Date: 2010-07-16 11:44:55 +0200 (Fri, 16 Jul 2010)
New Revision: 1857

Modified:
   pkg/Rcpp/inst/ChangeLog
   pkg/Rcpp/man/Rcpp-package.Rd
Log:
point to Rcpp-package vignette

Modified: pkg/Rcpp/inst/ChangeLog
===================================================================
--- pkg/Rcpp/inst/ChangeLog	2010-07-13 14:15:15 UTC (rev 1856)
+++ pkg/Rcpp/inst/ChangeLog	2010-07-16 09:44:55 UTC (rev 1857)
@@ -1,3 +1,8 @@
+2010-07-16  Romain Francois <romain at r-enthusiasts.com>
+
+	* man/Rcpp-package.Rd : removed old content and point to the Rcpp-package
+	vignette for current guidelines.
+
 2010-07-09  Dirk Eddelbuettel  <edd at debian.org>
 
 	* DESCRIPTION: Release 0.8.4

Modified: pkg/Rcpp/man/Rcpp-package.Rd
===================================================================
--- pkg/Rcpp/man/Rcpp-package.Rd	2010-07-13 14:15:15 UTC (rev 1856)
+++ pkg/Rcpp/man/Rcpp-package.Rd	2010-07-16 09:44:55 UTC (rev 1857)
@@ -8,6 +8,7 @@
   the \code{.Call} interface provided by \R.
 }
 \section{Overview}{
+	
   \pkg{Rcpp} provides matching C++ classes for a large number of
   basic \R data types. Hence, a package author can keep his data in
   normal R data structure without having to worry about translation or
@@ -46,52 +47,18 @@
   RcppMatrix of int or double, RcppFrame}
 }
 \section{Usage for package building}{
-  \pkg{Rcpp} provides a header file and a library inside the installed
-  package in the directory \code{lib}. From within \R, you can compute
-  the directory location via \code{system.file("include", "Rcpp.h", 
-    package="Rcpp")}. For Windows, it will be a static library
-  \sQuote{Rcpp.a}. For Linux and Mac OS X, it will be \sQuote{libRcpp.so}.
-
-  To use \code{Rcpp} in another package, you need to include the header
-  during compilation. This typically requires use of the \code{-I} to
-  provide the location as in \code{-I/usr/local/lib/R/site-library/Rcpp/include}.
-  Similarly, for linking we need to provide the location of the library
-  via \code{-L} as well as the actual library. An example for Linux
-  would be \code{-L/usr/local/lib/R/site-library/Rcpp/lib -lRcpp}.
-
-  In order to make it more convenient to use \code{Rcpp}, functions
-  providing these arguments were added.  To use these, simply use a file
-  \code{src/Makevars} such as this (which was taken from the
-  \code{emdL1} package)
-
-  \preformatted{
-# compile flag providing header directory containing Rcpp.h
-PKG_CXXFLAGS=$(shell $(R_HOME)/bin/Rscript -e 'Rcpp:::CxxFlags()')
-
-# link flag providing library as well as path to library, and optionally rpath
-PKG_LIBS=$(shell $(R_HOME)/bin/Rscript -e 'Rcpp:::LdFlags()')
+	The "Rcpp-package" vignette documents how to use Rcpp in client packages.
 }
-
-  Alternatively, one can also encode the test for these variables using
-  the \code{GNU autoconf} system. The \code{RQuantLib} package
-  provides an example of that.  
-
-  Lastly, on Linux, and during development, it can convenient to simply
-  provide these files via soft links (or copies) from the usual locations like
-  \sQuote{/usr/local/include} and \sQuote{/usr/local/lib} which
-  alleviates the need for explicit location flags like \sQuote{-I} or
-  \sQuote{-L}. Remember to also run \code{ldconfig} after creating the
-  link for the library.  Alternatively, you can hardcode the dynamic 
-  library location using the \code{rpath} linker directive:
-
-  Use on Windows is identical to the use in Linux. However only a static
-  library is provided. The two \code{\link{Rcpp}} functions detailed
-  above provide the relevant content.
-}
 \author{Dominick Samperi wrote the initial versions of Rcpp (and
   RcppTemplate) during 2005 and 2006.  Dirk Eddelbuettel made some
   additions, and became maintainer in 2008. Dirk Eddelbuettel and Romain
   Francois have been extending Rcpp since 2009.
 }
+\examples{
+\dontrun{
+# information on how to build a package that uses Rcpp
+vignette( "Rcpp-package" )	
+}
+}
 \keyword{programming}
 \keyword{interface}