Skip to content

[doc] Simplify the build args description #798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
allnes merged 1 commit into from
Jun 5, 2026
Merged

[doc] Simplify the build args description #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/user_guide/build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Navigate to the project root.

.. code-block:: bash

cmake -S . -B build -D USE_FUNC_TESTS=ON -D USE_PERF_TESTS=ON -D CMAKE_BUILD_TYPE=Release
cmake -S . -B build

To configure only selected tasks:

.. code-block:: bash

cmake -S . -B build -DPPC_TASKS="example_threads;example_processes" -D USE_FUNC_TESTS=ON -D USE_PERF_TESTS=ON -D CMAKE_BUILD_TYPE=Release
cmake -S . -B build -DPPC_TASKS="example_threads;example_processes"

Optional: enable sanitizers for local debugging

Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/ci.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ clang-tidy (static analysis):

# Configure with compile_commands.json
cmake -S . -B build -G Ninja -D CMAKE_BUILD_TYPE=Release -D CMAKE_EXPORT_COMPILE_COMMANDS=ON
cmake --build build -j
cmake --build build --parallel

# clang-tidy run:
### analyze all sources
Expand All @@ -116,14 +116,14 @@ gcovr (coverage, GCC):

# Configure with coverage flags (use GCC)
cmake -S . -B build -G Ninja -D USE_COVERAGE=ON -D CMAKE_BUILD_TYPE=Release
cmake --build build -j
cmake --build build --parallel

# Run tests here (threads/processes/performance)
scripts/run_tests.py --running-type=threads --counts 1 2 4

# Generate reports (install gcovr if needed: python3 -m pip install gcovr)
mkdir -p cov-report
(cd build && gcovr --gcov-executable "$(which gcov-14 || which gcov)" \
(cd build && gcovr --gcov-executable "$(which gcov)" \
Comment thread
aobolensk marked this conversation as resolved.
-r ../ \
--exclude '.*3rdparty/.*' \
--exclude '/usr/.*' \
Expand Down
Loading