|
|
@@ -76,13 +76,34 @@ of features as a standalone library:
|
|
|
- JSON-LD de/serialization
|
|
|
- SPARQL queries (We'll see... Will definitely need help)
|
|
|
|
|
|
-## Usage
|
|
|
+## Building
|
|
|
+
|
|
|
+- `make` to build the library as static and dynamic objects.
|
|
|
+- `make install` to install in a default location (`/usr/local`).
|
|
|
+- `make test` to compile into `./bin/test` and run a test suite.
|
|
|
+- `make memtest` same as `make test` but run the tests using Valgrind. Output
|
|
|
+ Valgrind results to a logfile.
|
|
|
+- `python setup.py bulid` or `pip install --user .`, or similar Python build
|
|
|
+ methods to build and install the `lsup_rdf` Python module.
|
|
|
+- `make pytest` to build the Python module and run a test suite on it.
|
|
|
+- `make depgraph` to create a PDF showing an `#include` dependency graph for
|
|
|
+ development purposes. Requires
|
|
|
+ [cinclude2dot](https://www.flourish.org/cinclude2dot) and Graphviz.
|
|
|
|
|
|
### Compile-Time Constants
|
|
|
|
|
|
`DEBUG`: Set debug mode: memory map is at reduced size, logging is forced to
|
|
|
TRACE level, etc.
|
|
|
|
|
|
+`LSUP_RDF_STREAM_CHUNK_SIZE`: Size of RDF decoding buffer, i.e., maximum size
|
|
|
+of a chunk of RDF data fed to the parser when decoding a RDF file into a graph.
|
|
|
+This should be larger than the maximum expected size of a single term in your
|
|
|
+RDF source. The default value is 8192, which is mildly conservative. If you
|
|
|
+experience parsing errors on decoding, and they happen to be on a term such a
|
|
|
+very long string literal, try recompiling the library with a larger value.
|
|
|
+
|
|
|
+## Running and Embedding
|
|
|
+
|
|
|
### Environment Variables
|
|
|
|
|
|
`LSUP_MDB_STORE_PATH`: The file path for the persistent store back end. For
|
|
|
@@ -102,13 +123,15 @@ be used. The directory must exist.
|
|
|
If unspecified, it is set to 3.
|
|
|
|
|
|
`LSUP_MDB_MAPSIZE` Virtual memory map size. It is recommended to leave this
|
|
|
-unset and let the software adjust it to the hardware architecture. By default,
|
|
|
-it is set to 1Tb for 64-bit systems and 4Gb for 32-bit systems. The map size by
|
|
|
-itself does not use up any extra resources.
|
|
|
+alone. By default, it is set to 1Tb for 64-bit systems and 4Gb for 32-bit
|
|
|
+systems. The map size by itself does not use up any extra resources.
|
|
|
|
|
|
-`LSUP_RDF_STREAM_CHUNK_SIZE`: Size of RDF decoding buffer, i.e., maximum size
|
|
|
-of a chunk of RDF data fed to the parser when decoding a RDF file into a graph.
|
|
|
-This should be larger than the maximum expected size of a single term in your
|
|
|
-RDF source. The default value is 8192, which is mildly conservative. If you
|
|
|
-experience parsing errors on decoding, and they happen to be on a term such a
|
|
|
-very long string literal, try recompiling the library with a larger value.
|
|
|
+
|
|
|
+### C API Documentation
|
|
|
+
|
|
|
+*TODO* Almost all header files are documented. Need a doc generator.
|
|
|
+
|
|
|
+
|
|
|
+### Python API Documentation
|
|
|
+
|
|
|
+*TODO*
|
