Skip to content

Use RelWithDebInfo for sanitizers, document build types #483

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
aobolensk merged 2 commits into from
Jun 25, 2025
Merged

Use RelWithDebInfo for sanitizers, document build types #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3865e3a
Clarify build types
aobolensk Jun 25, 2025
6847533
Fix leftovers
aobolensk Jun 25, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/ubuntu.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ jobs:
run: >
cmake -S . -B build -G Ninja
-D CMAKE_C_COMPILER_LAUNCHER=ccache -D CMAKE_CXX_COMPILER_LAUNCHER=ccache
-D CMAKE_BUILD_TYPE=RELEASE
-D CMAKE_BUILD_TYPE=RelWithDebInfo
-D ENABLE_ADDRESS_SANITIZER=ON -D ENABLE_UB_SANITIZER=ON -D ENABLE_LEAK_SANITIZER=ON
-D CMAKE_INSTALL_PREFIX=install
env:
Expand Down
12 changes: 9 additions & 3 deletions docs/locale/en/LC_MESSAGES/user_guide/build.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,15 @@ msgid "``-D USE_PERF_TESTS=ON`` enable performance tests."
msgstr ""

#: ../../user_guide/build.rst:22
msgid ""
"``-D CMAKE_BUILD_TYPE=Release`` required parameter for stable work of "
"repo."
msgid "``-D CMAKE_BUILD_TYPE=Release`` normal build (default)."
msgstr ""

#: ../../user_guide/build.rst:23
msgid "``-D CMAKE_BUILD_TYPE=RelWithDebInfo`` recommended when using sanitizers or running ``valgrind`` to keep debug information."
msgstr ""

#: ../../user_guide/build.rst:24
msgid "``-D CMAKE_BUILD_TYPE=Debug`` for debugging sessions."
msgstr ""

#: ../../user_guide/build.rst:24
Expand Down
16 changes: 10 additions & 6 deletions docs/locale/ru/LC_MESSAGES/user_guide/build.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,16 @@ msgid "``-D USE_PERF_TESTS=ON`` enable performance tests."
msgstr "``-D USE_PERF_TESTS=ON`` включает тесты на производительность."

#: ../../user_guide/build.rst:22
msgid ""
"``-D CMAKE_BUILD_TYPE=Release`` required parameter for stable work of "
"repo."
msgstr ""
"``-D CMAKE_BUILD_TYPE=Release`` требуемый CMake параметр для стабильной работы "
"репозитория."
msgid "``-D CMAKE_BUILD_TYPE=Release`` normal build (default)."
msgstr "``-D CMAKE_BUILD_TYPE=Release`` нормальная сборка (по умолчанию)."

#: ../../user_guide/build.rst:23
msgid "``-D CMAKE_BUILD_TYPE=RelWithDebInfo`` recommended when using sanitizers or running ``valgrind`` to keep debug information."
msgstr "``-D CMAKE_BUILD_TYPE=RelWithDebInfo`` рекомендуется при использовании санитайзеров или запуске ``valgrind`` для сохранения отладочной информации."

#: ../../user_guide/build.rst:24
msgid "``-D CMAKE_BUILD_TYPE=Debug`` for debugging sessions."
msgstr "``-D CMAKE_BUILD_TYPE=Debug`` используется при отладке."

#: ../../user_guide/build.rst:24
msgid "*A corresponding flag can be omitted if it's not needed.*"
Expand Down
5 changes: 4 additions & 1 deletion docs/user_guide/build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ Navigate to a source code folder.

- ``-D USE_FUNC_TESTS=ON`` enable functional tests.
- ``-D USE_PERF_TESTS=ON`` enable performance tests.
- ``-D CMAKE_BUILD_TYPE=Release`` required parameter for stable work of repo.
- ``-D CMAKE_BUILD_TYPE=Release`` normal build (default).
- ``-D CMAKE_BUILD_TYPE=RelWithDebInfo`` recommended when using sanitizers or
running ``valgrind`` to keep debug information.
- ``-D CMAKE_BUILD_TYPE=Debug`` for debugging sessions.

*A corresponding flag can be omitted if it's not needed.*

Expand Down
Loading