11# Build Environment
22We build CodeCompass in a Linux environment. Currently, Ubuntu Long-Term
3- Support releases are the main targets: Ubuntu 22.04 LTS (and Ubuntu 24.04 LTS
4- is planned).
3+ Support releases are the main targets: Ubuntu 22.04 LTS and Ubuntu 24.04 LTS.
54
65We also provide a Docker image that can be used as developer environment to
76CodeCompass. See its usage [ in a seperate document] ( /docker/README.md ) .
@@ -61,23 +60,40 @@ sudo apt install git cmake make g++ libboost-all-dev \
6160 libldap2-dev libgtest-dev
6261```
6362
63+ #### Ubuntu 24.04 ("Noble Numbat") LTS
64+
65+ ``` bash
66+ sudo apt install git cmake make g++ libboost-all-dev \
67+ llvm-15-dev clang-15 libclang-15-dev \
68+ gcc-13-plugin-dev thrift-compiler libthrift-dev \
69+ default-jdk libssl-dev libgraphviz-dev libmagic-dev libgit2-dev exuberant-ctags doxygen \
70+ libldap2-dev libgtest-dev
71+ ```
72+
6473#### Database engine support
6574
6675Depending on the desired database engines to be supported, the following
6776packages should be installed.
6877
69- ##### Ubuntu 22.04 ("Jammy Jellyfish") LTS
70-
71- The database connector library must be compiled manually for this release,
78+ The database connector library (ODB) must be compiled manually,
7279however, the database programs themselves should be installed from the
7380package manager.
7481
82+ ##### SQLite
83+
7584``` bash
76- # For SQLite database systems :
85+ # For Ubuntu 22.04, Ubuntu 24.04 :
7786sudo apt install libsqlite3-dev
87+ ```
88+
89+ ##### PostgreSQL
7890
79- # For PostgreSQL database systems:
91+ ``` bash
92+ # For Ubuntu 22.04:
8093sudo apt install postgresql-server-dev-14
94+
95+ # For Ubuntu 24.04:
96+ sudo apt install postgresql-server-dev-16
8197```
8298
8399## Known issues
@@ -91,10 +107,10 @@ by other processes which could, in extreme cases, make the system very hard or
91107impossible to recover. ** Please do NOT add a ` sudo ` in front of any ` make ` or
92108other commands below, unless * explicitly* specified!**
93109
94- ### ODB (for Ubuntu 22.04)
110+ ### ODB
95111ODB is an Object Relational Mapping tool, that is required by CodeCompass.
96- For Ubuntu 22.04 , the official release of ODB conflicts with the official
97- compiler (GNU G++ 11 ) of the distribution. A newer version of ODB must be
112+ In recent Ubuntu versions , the official release of ODB conflicts with the official
113+ compiler (GNU G++) of the distribution. A newer version of ODB must be
98114compiled manually.
99115
100116The ODB installation uses the build2 build system. (Build2 is not needed for
@@ -186,11 +202,7 @@ seen by CMake. Please set this environment before executing the build.
186202# For all supported OS versions:
187203export GTEST_ROOT=< gtest_install_dir>
188204
189- # If using Ubuntu 22.04:
190- export CMAKE_PREFIX_PATH=< thrift_install_dir> :$CMAKE_PREFIX_PATH
191205export CMAKE_PREFIX_PATH=< odb_install_directory> :$CMAKE_PREFIX_PATH
192-
193- export PATH=< thrift_install_dir> /bin:$PATH
194206export PATH=< odb_install_directory> /bin:$PATH
195207```
196208
0 commit comments