Skip to content

Commit

Permalink
iox-eclipse-iceoryx#1295 (DROP ME) Rework config guide and install guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mossmaurice committed Jan 30, 2025
1 parent d1af4af commit bbf7136
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/website/advanced/configuration-guide.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/website/advanced/installation-guide-for-contributors.md
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit bbf7136

Please sign in to comment.