From bbf71367102ed86c577e90aaea64384058660f76 Mon Sep 17 00:00:00 2001 From: Simon Hoinkis Date: Thu, 30 Jan 2025 14:49:12 +0100 Subject: [PATCH] iox-#1295 (DROP ME) Rework config guide and install guide --- doc/website/advanced/configuration-guide.md | 4 ++-- doc/website/advanced/installation-guide-for-contributors.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/website/advanced/configuration-guide.md b/doc/website/advanced/configuration-guide.md index d80750586b..11568b213d 100644 --- a/doc/website/advanced/configuration-guide.md +++ b/doc/website/advanced/configuration-guide.md @@ -1,6 +1,6 @@ # Configuration guide -## CMake switches for configuring iceoryx_hoofs and iceoryx_posh build +## :material-cog: CMake switches for configuring iceoryx_hoofs and iceoryx_posh build There are several configuration options set by default when iceoryx_hoofs and iceoryx_posh are build. These options adjust the minimal log level compiled @@ -79,7 +79,7 @@ This way, the ACL feature is disabled across builds without needing to pass the > > This ensures that the flag is applied to the correct target from the imported repository. -## Configuring Mempools for RouDi +## :material-memory: Configuring Mempools for RouDi RouDi supports several shared memory segments with different access rights, to limit the read and write access between different applications. Memory pools diff --git a/doc/website/advanced/installation-guide-for-contributors.md b/doc/website/advanced/installation-guide-for-contributors.md index 2cbb1f128a..7cb378190d 100644 --- a/doc/website/advanced/installation-guide-for-contributors.md +++ b/doc/website/advanced/installation-guide-for-contributors.md @@ -1,6 +1,6 @@ # Installation guide for contributors -## Build and run tests +## :material-test-tube: Build and run tests While developing on iceoryx, you may want to know if your changes will break existing functionality or if your newly written tests will pass. For that purpose, we generate CMake targets that execute the tests. First, @@ -55,7 +55,7 @@ Let's assume you want to execute only `ServiceDescription_test` from posh_module While writing code on iceoryx you should use git hooks that automatically ensure that you follow the coding and style guidelines. See [`git-hooks`](../../../tools/git-hooks/Readme.md). -## Use Sanitizer Scan +## :fontawesome-solid-pump-soap: Use Sanitizer Scan Due to the fact that iceoryx works a lot with system memory, it should be ensured that errors like memory leaks are not introduced. To prevent this, we use the clang toolchain which offers several tools for scanning the codebase. One of them is the