[Rcpp-commits] r4568 - in pkg/RcppGSL: . man

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

Author: edd
Date: 2013-10-10 02:53:10 +0200 (Thu, 10 Oct 2013)
New Revision: 4568

Added:
   pkg/RcppGSL/man/LdFlags.Rd
Modified:
   pkg/RcppGSL/ChangeLog
   pkg/RcppGSL/NAMESPACE
Log:
Export LdFlags and CFlags, and added documentation for exported functions


Modified: pkg/RcppGSL/ChangeLog
===================================================================
--- pkg/RcppGSL/ChangeLog	2013-10-09 22:45:15 UTC (rev 4567)
+++ pkg/RcppGSL/ChangeLog	2013-10-10 00:53:10 UTC (rev 4568)
@@ -1,11 +1,12 @@
 2013-10-09  Dirk Eddelbuettel  <edd at debian.org>
 
-	* NAMESPACE: Import LdFlags from Rcpp
+	* NAMESPACE: Import LdFlags from Rcpp, and export LdFlags and CFlags
+	* man/LdFlags.Rd: Added documentation for exported functions
 
 2013-09-10  Dirk Eddelbuettel  <edd at debian.org>
 
 	* DESCRIPTION (Imports): Now 'Imports: Rcpp' rather than Depends: to
-	satisfy R CMD check for the R version under development 
+	satisfy R CMD check for the R version under development
 
 2013-08-24  Dirk Eddelbuettel  <edd at debian.org>
 

Modified: pkg/RcppGSL/NAMESPACE
===================================================================
--- pkg/RcppGSL/NAMESPACE	2013-10-09 22:45:15 UTC (rev 4567)
+++ pkg/RcppGSL/NAMESPACE	2013-10-10 00:53:10 UTC (rev 4568)
@@ -3,7 +3,9 @@
 importFrom(utils,assignInNamespace)
 importFrom(Rcpp,LdFlags)
 export(fastLmPure,
-       fastLm)
+       fastLm,
+       LdFlags,
+       CFlags)
 S3method(fastLm, default)
 S3method(fastLm, formula)
 S3method(predict, fastLm)

Added: pkg/RcppGSL/man/LdFlags.Rd
===================================================================
--- pkg/RcppGSL/man/LdFlags.Rd	                        (rev 0)
+++ pkg/RcppGSL/man/LdFlags.Rd	2013-10-10 00:53:10 UTC (rev 4568)
@@ -0,0 +1,47 @@
+\name{LdFlags}
+\alias{LdFlags}
+\alias{CFlags}
+\title{Provide RcppGSL Compiler and Linker Flags}
+\description{
+  \code{LdFlags} and \code{CFlags} return the required flags and
+  options for the compiler and system linker in order to build against
+  GNU GSL. This allows portable use of \pkg{RcppGSL} (which needs the
+  GNU GSL) as package location as well as operating-system specific
+  details are abstracted away behind the interface of this function.
+
+  \code{LdFlags} and \code{CFlags} are commonly called from the files
+  \code{Makevars} (or \code{Makevars.win}) rather than in an interactive
+  session. 
+}
+\usage{
+LdFlags(print=TRUE)
+RcppLdFlags(print=TRUE)
+}
+\arguments{
+  \item{print}{A boolean determining whether the requested value is
+  returned on the standard output, or silenly as a value.}
+}
+\value{
+  A character vector suitable by use by the system compiler linker in order to
+  compile and/or link against the GNU GSK.
+}
+\details{
+  Thee functions are not meant to used interactively, and are intended
+  solely for use by the build tools.
+
+  The values that are returned are acquired by the package at load
+  time. On Linux and OS X, the \code{pkg-config} program is queried. On
+  Windows, environment variables used for GNU GSL builds with R are used.
+}
+\references{
+  Dirk Eddelbuettel and Romain Francois (2011). \pkg{Rcpp}: Seamless R
+  and C++ Integration. \emph{Journal of Statistical Software},
+  \bold{40(8)}, 1-18. URL http://www.jstatsoft.org/v40/i08/ and
+  available as \code{vignette("Rcpp-introduction")}.
+}
+\seealso{
+  The document of the \code{pkg-config} system tool.
+}
+\author{Dirk Eddelbuettel and Romain Francois}
+\keyword{programming}
+\keyword{interface}