Add a README on need for RINSIDE_CALLBACKS for sandboxed server

eddelbuettel · Sep 17, 2023 · db0d572 · db0d572
1 parent 2cf4094
commit db0d572
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,8 @@
+2023-09-17  Dirk Eddelbuettel  <[email protected]>
+
+	* inst/examples/sandboxed_server/README.md: Add README noting need to
+	rebuild RInside with `RINSIDE_CALLBACKS` defined
+
 2023-03-16  Dirk Eddelbuettel  <[email protected]>
 
 	* DESCRIPTION (Version, Date): Roll minor version

diff --git a/inst/examples/sandboxed_server/README.md b/inst/examples/sandboxed_server/README.md
@@ -0,0 +1,11 @@
+
+## Sandboxed Server
+
+The example provided in this directory requires `RInside` to be built with
+callback support.  This can be enabled by uncommenting one line in the file
+`RInsideConfig.h` to define the preprocessor constant `RINSIDE_CALLBACKS`,
+and then rebuilding.
+
+Alternatively, adding a compiler flag `-DRINSIDE_CALLBACKS` and reinstalling
+would do too; this also requires using the same flag when building the
+example or similar applications.