Changeset: cb977914e8ac for MonetDB URL: https://dev.monetdb.org/hg/MonetDB/rev/cb977914e8ac Modified Files: documentation/source/build-fedora.rst documentation/source/build.rst Branch: Dec2023 Log Message:
Doc fixes. diffs (98 lines): diff --git a/documentation/source/build-fedora.rst b/documentation/source/build-fedora.rst --- a/documentation/source/build-fedora.rst +++ b/documentation/source/build-fedora.rst @@ -16,7 +16,7 @@ These packages are required. | cmake # version >= 3.12 | bison -| gettext-devel +| gcc | libxml2-devel | mercurial diff --git a/documentation/source/build.rst b/documentation/source/build.rst --- a/documentation/source/build.rst +++ b/documentation/source/build.rst @@ -6,18 +6,18 @@ Summary ======= For cmake, you should always build the code in a separate directory, say -"build". This directory should be outside of the source code tree. The -results of the build are stored in this directory. The location on the +"build". This directory should be outside of the source code tree. The +results of the build are stored in this directory. The location in the filesystem is not important, as long as you have permissions to write in that location. Assuming the MonetDB source code is checked out in directory "/path/to/monetdb/source", and if you have all the required packages (see below) to build MonetDB, these are the set of commands to build and -install it from source. Install is one of the predefined targets -[``install``, ``test``, ``mtest``]. When you test MonetDB, you will +install it from source. Install is one of the predefined targets +[``install``, ``test``, ``mtest``]. When you test MonetDB, you will likely not want to install it in the default location, the standard GNU -directory structure. So you may want to set the install prefix variable +directory structure. So you may want to set the install prefix variable when generating the build system, using ``-DCMAKE_INSTALL_PREFIX``:: mkdir build @@ -37,8 +37,8 @@ Role of clients?? How to install For testing, you likely don't want to install in the default location, so you need to add the installation prefix parameter to the cmake -command. But you do not need any configuration to run mtest (on -Linux). Just run the command:: +command. But you do not need any configuration to run mtest (on Linux). +Just run the command:: cmake --build . --target mtest @@ -47,29 +47,29 @@ Configuration options The way options interact with building of the MonetDB source has fundamentally changed from the way this was done using the autotools -build system. Now almost all options are on by default. And these options -mostly control library detection. In the old system, it was possible to -build a subset of the code base. For example, you could choose not to -build the sql part. Now the every part of the code is build, as long as -the dependent libraries are detected. And by default, the system would -try to detect all dependent libraries. If your system does not have a -required library, that section of the code will not be build. Only if -you want to prevent the build of a certain section, you could use the -option to prevent that a dependency is detected. +build system. Now almost all options are on by default. And these +options mostly control library detection. In the old system, it was +possible to build a subset of the code base. For example, you could +choose not to build the sql part. Now every part of the code is built, +as long as the dependent libraries are detected. And by default, the +system would try to detect all dependent libraries. If your system does +not have a required library, that section of the code will not be built. +Only if you want to prevent the build of a certain section, you could +use the option to prevent that a dependency is detected. 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, Debug, RelWithDebInfo and MinSizeRel. The -first 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 RelWithDebInfo -combines Release and Debug with both compiler optimizations and symbol -tables for debugging. Finally MinSizeRel is a Release build optimized -for binary size instead of speed. +takes the value ``Release``, ``Debug``, ``RelWithDebInfo`` and +``MinSizeRel``. The first 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 need access to the +symbol tables. This build type also typically leads to a slower +execution time, because all kinds of assertions will be checked. The +``RelWithDebInfo`` combines ``Release`` and ``Debug`` with both compiler +optimizations and symbol tables for debugging. Finally ``MinSizeRel`` +is a Release build optimized for binary size instead of speed. Other relevant properties are also ``-DASSERT=ON`` and ``-DSTRICT=ON``, used in combination with a Debug build, e.g.:: _______________________________________________ checkin-list mailing list -- checkin-list@monetdb.org To unsubscribe send an email to checkin-list-le...@monetdb.org
