[Rcpp-commits] r2851 - in pkg/RcppBDT: . inst/include

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

Author: edd
Date: 2011-01-08 16:08:32 +0100 (Sat, 08 Jan 2011)
New Revision: 2851

Modified:
   pkg/RcppBDT/ChangeLog
   pkg/RcppBDT/DESCRIPTION
   pkg/RcppBDT/inst/include/RcppBDT.h
Log:
added some documentation for UseWithStrings in header file and DESCRIPTION


Modified: pkg/RcppBDT/ChangeLog
===================================================================
--- pkg/RcppBDT/ChangeLog	2011-01-08 14:28:41 UTC (rev 2850)
+++ pkg/RcppBDT/ChangeLog	2011-01-08 15:08:32 UTC (rev 2851)
@@ -1,3 +1,14 @@
+2011-01-06  Dirk Eddelbuettel  <edd at dexter>
+
+	* inst/include/RcppBDT.h: Added paragraph about the UseWithString
+	variable with governs whether input/output functionality is loaded
+	which then requires linking with the Boost Date_Time library. Default
+	is just templates and no input/output given just basic date conversion
+	but no parsing from or formatting to string.
+
+	* DESCRIPTION: Expanded Description, mentioned optional linking of
+	Boost library to get string to/from date conversion functionality
+
 2011-01-05  Dirk Eddelbuettel  <edd at debian.org>
 
 	* src/RcppBDT.cpp: Expose new functions to compute IMM date (third

Modified: pkg/RcppBDT/DESCRIPTION
===================================================================
--- pkg/RcppBDT/DESCRIPTION	2011-01-08 14:28:41 UTC (rev 2850)
+++ pkg/RcppBDT/DESCRIPTION	2011-01-08 15:08:32 UTC (rev 2851)
@@ -1,7 +1,7 @@
 Package: RcppBDT
 Type: Package
 Title: Rcpp bindings for the Boost Date_Time library 
-Version: 0.0.1
+Version: 0.0.2
 Date: $Date$
 Author: Dirk Eddelbuettel and Romain Francois
 Maintainer: Dirk Eddelbuettel <edd at debian.org>
@@ -9,8 +9,12 @@
  functonality by using Rcpp modules. 
  .
  Currently only Date functionality is covered.
+ .
+ Boost header files are needed to build the package. Linking is optional and
+ provides supplmentary date to/from strings conversion functions.
 License: GPL (>= 2)
 LazyLoad: yes
 Depends: Rcpp (>= 0.9.0), methods
+SystemRequirements: Boost 
 LinkingTo: Rcpp
 

Modified: pkg/RcppBDT/inst/include/RcppBDT.h
===================================================================
--- pkg/RcppBDT/inst/include/RcppBDT.h	2011-01-08 14:28:41 UTC (rev 2850)
+++ pkg/RcppBDT/inst/include/RcppBDT.h	2011-01-08 15:08:32 UTC (rev 2851)
@@ -24,11 +24,15 @@
 
 #include <RcppCommon.h>
 
-// this variable governs whether we need to link against 
+// Setting this variable governs whether we need to link against the
+// Boost Date.Time library (eg -lboost_date_time on Debian/Ubuntu) or
+// not The functions not involving string parsing or conversion are
+// all available via the templated Boost header files and are thus
+// compile-time only which make things a little easier.
+// On Windows, set the BOOSTLIB variable to point to a suitable directory.
+// On other systems, just have Boost in the include path 
 #define UseWithStrings 0
 
-//#include <boost/date_time.hpp>
-
 #if UseWithString
   #include <boost/date_time/gregorian/gregorian.hpp> 	// Gregorian calendar types, including I/O
 #else