Skip to content

Commit e6c4fd3

Browse files
iox-#1295 Rework config guide and install guide
1 parent c028198 commit e6c4fd3

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/website/advanced/configuration-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration guide
22

3-
## CMake switches for configuring iceoryx_hoofs and iceoryx_posh build
3+
## :material-cog: CMake switches for configuring iceoryx_hoofs and iceoryx_posh build
44

55
There are several configuration options set by default when iceoryx_hoofs
66
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
7979
>
8080
> This ensures that the flag is applied to the correct target from the imported repository.
8181
82-
## Configuring Mempools for RouDi
82+
## :material-memory: Configuring Mempools for RouDi
8383
8484
RouDi supports several shared memory segments with different access rights, to
8585
limit the read and write access between different applications. Memory pools

doc/website/advanced/installation-guide-for-contributors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installation guide for contributors
22

3-
## Build and run tests
3+
## :material-test-tube: Build and run tests
44

55
While developing on iceoryx, you may want to know if your changes will break existing functionality or if your
66
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
5555
While writing code on iceoryx you should use git hooks that automatically ensure that you follow the coding and style guidelines.
5656
See [`git-hooks`](../../../tools/git-hooks/Readme.md).
5757

58-
## Use Sanitizer Scan
58+
## :fontawesome-solid-pump-soap: Use Sanitizer Scan
5959

6060
Due to the fact that iceoryx works a lot with system memory, it should be ensured that errors like memory leaks are not introduced.
6161
To prevent this, we use the clang toolchain which offers several tools for scanning the codebase. One of them is the

0 commit comments

Comments
 (0)