Changeset: 4484564e2c95 for MonetDB
URL: https://dev.monetdb.org/hg/MonetDB?cmd=changeset;node=4484564e2c95
Modified Files:
README.md
Branch: mbedded
Log Message:
More documentation needed
diffs (49 lines):
diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -1,18 +1,41 @@
-# MonetDB
+# Building MonetDB from source
## Summary
-For cmake, you should always build the code in a separete directory. For
testing, you will likely don't want to install in the default location, so you
need to add a parameter to the cmake command. Assuming the monetdb source code
is checked out in "~/hg/MonetDB". And if you have all the required packages to
build MonetDB, these are the set of commands to build and install it from
source.
+For cmake, you should always build the code in a separate directory, say
${SOURCE}.
+The results of the build are stored in a location designated by ${PREFIX}, a
full path
+to the location you want the binaries to be stored.
+Make sure you have these environment variables set and you have write
permissions to the ${PREFIX} location
+
+Assuming the monetdb source code is checked out in directory "${SOURCE}".
+And if you have all the required packages(*) to build MonetDB, these are the
set of commands to build and *install* it from source.
+(*) what packages are required?
```
mkdir build
cd build
-cmake -DCMAKE_INSTALL_PREFIX=/tmp/monetdb ~/hg/MonetDB/
+cmake -DCMAKE_INSTALL_PREFIX=/tmp/monetdb ${SOURCE}
cmake --build .
cmake --build . --target install
```
-## Debian
+## Testing
+For testing, you likely don't want to install in the default location, so you
need to add a parameter to the cmake command.
+??explain what install does? is it a directory name? is it --target modifier?
+
+##Configuration options
+Evidently there are several options to control as illustrated in
$SOURCE/cmake/monetdb-options.cmake
+
+The important once to choose from are -DCMAKE-BUILD_TYPE, which takes the
value Release or Debug.
+The former creates the binary ready for shipping, including all compiler
optimizations that come with it.
+The Debug mode is necessary if you plan to debug the binary and needs access
to the symbol tables.
+This build type also typically leads to a slower execution time, because also
all kinds of assertions
+are being checked.
+
+The relevant properties are also -DASSERT=ON and DSTRICT=ON
+
+## Platform specifics
+### Debian
## Fedora
_______________________________________________
checkin-list mailing list
[email protected]
https://www.monetdb.org/mailman/listinfo/checkin-list
