v3c-schema Code
Status: Alpha
Brought to you by:
philipashmore
Introduction ============ This project created itself by being too big for v3c-repo. The v3c-schema program reads schema scripts and generates a header file defining the schema interface. The interface can be either generic (independent of treedb offset size) and tuned (targettable to any specific treedb offset size). In case you missed it from reading the treedb documentation, the offset size is what is used to store offsets within a treedb, so the larger the maximum treedb size, the larger the offset size must be, and the more space it uses. It makes sense to use the offset size consistently within a treedb that can store any offset required of it without taking up too much space. Directory layout ================ treedb (you are here) |- build (everything created goes here, as far as the tools will allow) | \- v3c | \- examples \- v3c (the source) \- examples The reason for the "v3c" subdirctory is so test programs can #include <v3c/something> just like client programs. This works as -isystem \$(srcdir) is added to CPPFLAGS by configure.ac.in. Requirements ============ This is a sub-project of meta-treedb so you'll need that and all that it requires. Debian/Ubuntu packages ====================== If you run make debian the build system will compile and distcheck meta-treedb before creating a .tar.gz tar ball. This tar ball is then used by the build system to build the debian packages. You will need a gpg public/private key pair if you want to sign these packages - more info can be found in the "maint-guide" debian package. doxygen ======= I've cobbled together a doxygen "documentation chain" so that other projects can layer their doxygen documentation on top easily. Then to install the documentation make <flags> doxygen-doc && sudo make install-doxygen-doc Using v3c-schema ================ The default install location determined by configure is "/usr". You can specify your own (eg. ~/test) by make prefix=~/test check Feedback ======== All feedback should be through this projects support web page http://sourceforge.net/projects/v3c-schema/support. I've added a help, open discussion and a mantis bug tracker there. Finally, do send me an email to let me know what your thoughts are on v3c-schema!