Skip to content
Snippets Groups Projects
Verified Commit 28ee3480 authored by Timm Fitschen's avatar Timm Fitschen
Browse files

DOC: some additional docs for building

parent 0f81bb27
No related branches found
No related tags found
No related merge requests found
Checking pipeline status
...@@ -12,9 +12,9 @@ We use [cmake](https://cmake.org) as build tool. ...@@ -12,9 +12,9 @@ We use [cmake](https://cmake.org) as build tool.
#### protobufConfig.cmake not found #### protobufConfig.cmake not found
If you encounter something like `PprotobufConfig.cmake` when doing If you encounter something like `protobufConfig.cmake not found` when doing
`cmake ..` your system doesn't have the gRPC library installed at all `cmake -B . ..` your system doesn't have the gRPC library installed at all
or your installation doesn't have the required `ProtobufConfig.cmake` or your installation doesn't have the required `protobufConfig.cmake`
file. In this case you can install grpcc manually by cloning the file. In this case you can install grpcc manually by cloning the
repository and its submodules nad building it from the sources: repository and its submodules nad building it from the sources:
...@@ -55,8 +55,8 @@ make -j3 ...@@ -55,8 +55,8 @@ make -j3
make install make install
``` ```
As above, it may make sens to specify a `CMAKE_INSTALL_PREFIX` in As above, it may make sense to specify a `CMAKE_INSTALL_PREFIX` in
order to not interfere with system-wide installations. order to not interfere with system-wide installations.
You may have to repeat this for other submodules that haven't been You may have to repeat this for other submodules that haven't been
installed correctly by `make install` of `grpc`. installed correctly by `make install` of `grpc`.
...@@ -81,7 +81,7 @@ Depending on your gtest installation, there may be warnings treated as ...@@ -81,7 +81,7 @@ Depending on your gtest installation, there may be warnings treated as
errors during the above build command, e.g., a errors during the above build command, e.g., a
`-Werror=maybe-uninitialized` in `-Werror=maybe-uninitialized` in
`caosdb-cpplib-new/build/_deps/googletest-src/googletest/src/gtest-death-test.cc`. In `caosdb-cpplib-new/build/_deps/googletest-src/googletest/src/gtest-death-test.cc`. In
that case, suprress the corresponding warning by adding that case, suppress the corresponding warning by adding
`-DCMAKE_CXX_FLAGS="-Wno-maybe-uninitialized"` to the cmake command in 2. `-DCMAKE_CXX_FLAGS="-Wno-maybe-uninitialized"` to the cmake command in 2.
### Framework ### Framework
...@@ -105,7 +105,8 @@ The coverage report can be viewed in a browser by opening ...@@ -105,7 +105,8 @@ The coverage report can be viewed in a browser by opening
## Code Formatting ## Code Formatting
* `clang-format -i --verbose **/*.cpp **/*.h` * install clang-format on your system.
* `clang-format -i --verbose $(find test/ src/ include/ -type f -iname "*.cpp" -o -iname "*.h" -o -iname "*.h.in")`
## Documentation ## Documentation
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment