From 28ee3480eb08d735d5b7028d66cea2c0a526f85c Mon Sep 17 00:00:00 2001 From: Timm Fitschen <t.fitschen@indiscale.com> Date: Thu, 1 Jul 2021 20:51:19 +0200 Subject: [PATCH] DOC: some additional docs for building --- README_SETUP.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README_SETUP.md b/README_SETUP.md index eeb9908..14139ea 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -12,9 +12,9 @@ We use [cmake](https://cmake.org) as build tool. #### protobufConfig.cmake not found -If you encounter something like `PprotobufConfig.cmake` when doing -`cmake ..` your system doesn't have the gRPC library installed at all -or your installation doesn't have the required `ProtobufConfig.cmake` +If you encounter something like `protobufConfig.cmake not found` when doing +`cmake -B . ..` your system doesn't have the gRPC library installed at all +or your installation doesn't have the required `protobufConfig.cmake` file. In this case you can install grpcc manually by cloning the repository and its submodules nad building it from the sources: @@ -55,8 +55,8 @@ make -j3 make install ``` -As above, it may make sens to specify a `CMAKE_INSTALL_PREFIX` in -order to not interfere with system-wide installations. +As above, it may make sense to specify a `CMAKE_INSTALL_PREFIX` in +order to not interfere with system-wide installations. You may have to repeat this for other submodules that haven't been installed correctly by `make install` of `grpc`. @@ -81,7 +81,7 @@ Depending on your gtest installation, there may be warnings treated as errors during the above build command, e.g., a `-Werror=maybe-uninitialized` 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. ### Framework @@ -105,7 +105,8 @@ The coverage report can be viewed in a browser by opening ## 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 -- GitLab