Skip to content

Commit 7ca971d

Browse files
reworded LdFlags dcumentation. closes #54
1 parent 99710b8 commit 7ca971d

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

man/RcppLdFlags.Rd

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,26 @@
11
\name{LdFlags}
22
\alias{LdFlags}
33
\alias{RcppLdFlags}
4-
\title{Provide Rcpp Linker Flags}
4+
\title{(Deprecated) Rcpp Linker Flags}
55
\description{
6-
\code{LdFlags} and \code{RcppLdFlags} return the required flags and
7-
options for the system linker. This allows portable use of
8-
\pkg{Rcpp} as package location as well as operating-system specific
9-
details are abstracted away behind the interface of this function.
10-
11-
\code{LdFlags} is commonly called from the files \code{Makevars} (or
12-
\code{Makevars.win}) rather than in an interactive session.
6+
In previous versions of Rcpp, \code{LdFlags} and \code{RcppLdFlags}
7+
were used to return the required flags and options for the system linker to
8+
link to the Rcpp user library. Since we no longer build or ship a
9+
user library, these functions now return an empty string.
1310
}
1411
\usage{
1512
LdFlags()
1613
RcppLdFlags()
1714
}
1815
\value{
19-
A character vector suitable by use by the system linker in order to
20-
create a library based on \pkg{Rcpp}.
21-
}
22-
\details{
23-
Thee functions are not meant to used interactively, and are intended
24-
solely for use by the build tools.
16+
An empty string.
2517
}
2618
\references{
2719
Dirk Eddelbuettel and Romain Francois (2011). \pkg{Rcpp}: Seamless R
2820
and C++ Integration. \emph{Journal of Statistical Software},
2921
\bold{40(8)}, 1-18. URL http://www.jstatsoft.org/v40/i08/ and
3022
available as \code{vignette("Rcpp-introduction")}.
3123
}
32-
\seealso{
33-
The vignette \sQuote{Rcpp-package} has more details.
34-
}
3524
\author{Dirk Eddelbuettel and Romain Francois}
3625
\keyword{programming}
3726
\keyword{interface}

0 commit comments

Comments
 (0)