Skip to content

Commit 1a5b82d

Browse files
mossmaurice-apexaimossmaurice-apexai
authored
Merge pull request #2398 from ApexAI/iox-1295-release-validation-v3-0
Update MkDocs and documentation preparing for `v3.0` release
2 parents f33d582 + 7e18fa4 commit 1a5b82d

19 files changed

+483
-202
lines changed

‎.lycheeignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@ https://github.com/eclipse-iceoryx/iceoryx/compare/vx.x.x...vx.x.x
22
https://github.com/eclipse-iceoryx/iceoryx/tree/vx.x.x
33
https://www.misra.org.uk/
44
https://www.gnu.org/software/screen/
5+
https://www.etas.com/
56

67
[email protected]

‎doc/aspice_swe3_4/CMakeLists.txt‎

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -53,33 +53,12 @@ swcomponent="@par Software Component:" \
5353
error="@par Error Handling:" \
5454
generatedcode="@par Generated by:"]])
5555

56+
# Do not add new sub-components in this list but use 'INCLUDE_DIR_AND_ADDITIONAL_FILES'
5657
set(COMPONENTS iceoryx_platform iceoryx_hoofs iceoryx_posh iceoryx_binding_c
5758
iceoryx_introspection iceoryx_component)
5859
set(COMPONENT_DIRS
5960
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_platform/generic
60-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/buffer
61-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/cli
62-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/concurrent/buffer
63-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/concurrent/sync
64-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/container
65-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/design
66-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/filesystem
67-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/functional
68-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/legacy/include
69-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/memory
70-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/auth
71-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/desig
72-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/filesystem
73-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/ipc
74-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/sync
75-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/time
76-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/utility
77-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/vocabulary
78-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/primitives
79-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/reporting
80-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/time
81-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/utility
82-
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/vocabulary
61+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/legacy
8362
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_posh
8463
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_binding_c
8564
${CMAKE_CURRENT_SOURCE_DIR}/../../tools/introspection
@@ -117,6 +96,33 @@ foreach(val RANGE ${cmp_len})
11796
)
11897
endif()
11998

99+
if(${cmp} STREQUAL iceoryx_hoofs)
100+
list(APPEND INCLUDE_DIR_AND_ADDITIONAL_FILES
101+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/buffer
102+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/cli
103+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/concurrent/buffer
104+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/concurrent/sync
105+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/container
106+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/design
107+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/filesystem
108+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/functional
109+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/memory
110+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/auth
111+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/design
112+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/filesystem
113+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/ipc
114+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/sync
115+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/time
116+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/utility
117+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/posix/vocabulary
118+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/primitives
119+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/reporting
120+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/time
121+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/utility
122+
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs/vocabulary
123+
)
124+
endif()
125+
120126
doxygen_add_docs(doxygen_${cmp}
121127
${INCLUDE_DIR_AND_ADDITIONAL_FILES}
122128
WORKING_DIRECTORY ${cmp_dir}/include

‎doc/website/advanced/available-bindings-extensions.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Available bindings and extensions
2+
3+
The following bindings and extensions are available for iceoryx:
4+
5+
| Name | Description | Link |
6+
|------------------------|-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
7+
| DDS gateway | Gateway to the DDS protocol using [Cyclone DDS](https://cyclonedds.io/) or [FastDDS](https://github.com/eProsima/Fast-DDS) | [https://github.com/eclipse-iceoryx/iceoryx-gateway-dds](https://github.com/eclipse-iceoryx/iceoryx-gateway-dds) |
8+
| Rust binding | Binding to use the C++ version of iceoryx in Rust projects | [https://github.com/eclipse-iceoryx/iceoryx-rs](https://github.com/eclipse-iceoryx/iceoryx-rs) |
9+
| Automotive SOA binding | Binding to use iceoryx for SOA APIs like [AUTOSAR Adaptive](https://www.autosar.org/standards/adaptive-platform/) projects | [https://github.com/eclipse-iceoryx/iceoryx-automotive-soa](https://github.com/eclipse-iceoryx/iceoryx-automotive-soa) |

‎doc/website/advanced/iceoryx-on-32-bit.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Status
1+
# iceoryx on 32 bit architectures
22

33
iceoryx works on 32-bit hardware, but only as technology preview and is not meant for production.
44

5-
See also https://github.com/eclipse-iceoryx/iceoryx/issues/2301 for more details and the limitations sections in this document.
5+
See also [here](https://github.com/eclipse-iceoryx/iceoryx/issues/2301) for more details and the limitations sections in this document.
66

7-
# Dependencies
7+
## Dependencies
88

99
For 32-bit support, the following packages need to be installed on ubuntu
1010

@@ -13,7 +13,7 @@ sudo dpkg --add-architecture i386
1313
sudo apt install libacl1-dev:i386 libc6-dev-i386 libc6-dev-i386-cross libstdc++6-i386-cross gcc-multilib g++-multilib
1414
```
1515

16-
# iceoryx as 32-bit library
16+
## iceoryx as 32-bit library
1717

1818
## Build steps
1919

@@ -42,7 +42,7 @@ Furthermore, it is required for the 32-64 bit mix-mode to enforce the same data
4242
An internal data structure, the `UsedChunkList`, might be left in a corrupt state when an application terminates abnormally when writing to this data structure.
4343
In order to detect torn-writes on 32-bit, the data structure needs to be refactored.
4444

45-
# iceoryx for communication between 32-bit and 64-bit applications aka 32-64 bit mix-mode
45+
## iceoryx for communication between 32-bit and 64-bit applications aka 32-64 bit mix-mode
4646

4747
## Attention
4848

@@ -65,7 +65,7 @@ If the layout differs, it can lead to unpredictable behavior and errors in the a
6565
6666
The simplest way to fix this specific alignment issue, is to use the `-malign-double` flag, which enforces an 8 byte alignment boundary for 64-bit data types on 32-bit architectures.
6767
68-
## Build steps
68+
### Build steps
6969
7070
Similar to the 32-bit build, the simplest way to build for the 32-64 bit mix-mode is the `iceoryx_build_test.sh` script
7171
@@ -102,7 +102,7 @@ build-64/iceoryx_examples/request_response/iox-cpp-request-response-listener-ser
102102
build-32/iceoryx_examples/request_response/iox-cpp-request-response-waitset-client
103103
```
104104

105-
## Limitations
105+
### Limitations
106106

107107
In addition to the limitations of the 32-bit iceoryx, the mix-mode needs to ensure that all the data structures in shared memory have the same layout.
108108
While the `-malign-double` flag can be used for the iceoryx data types, it does not work for POSIX data structures like `sem_t`.

‎doc/website/advanced/roudi-command-line-arguments.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Command line arguments of RouDi
2+
3+
To view the available command line options for RouDi call `iox-roudi --help`.
4+
5+
| Short | Long | Parameter | Explanation |
6+
|-------|---------------------|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7+
| -h | --help | None | Prints the available options |
8+
| -v | --version | None | Prints the version string |
9+
| -d | --domain-id | Unsigned integer | Sets the domain id. No communication can happen between different domains. Experimental feature! |
10+
| -u | --unique-roudi-id | Unsigned integer | Sets the unique RouDi identifier |
11+
| -m | --monitoring-mode | String (on, off) | Enables or disables the process alive monitoring feature. If enabled RouDi terminates and kills unresponsive process. |
12+
| -l | --log-level | String (off, fatal, error, warning, info, debug, trace) | Set the log level. Default log level is 'info'. |
13+
| -x | --compatibility | String (off, major, minor, patch, commitId, buildDate) | Sets the compatibility check level between application and RouDi. Default is 'patch'. This can be useful if old apps are build against and old iceoryx version. Use with care! |
14+
| -t | --termination-delay | Unsigned integer | Sets the delay in seconds before RouDi sends SIGTERM to running applications at shutdown. Default is '0'. |
15+
| -k | --kill-delay | Unsigned integer | Sets the delay in seconds before RouDi sends SIGKILL to application which did not respond to the initial SIGTERM signal. Default is '45'. |
16+
| -c | --config-file | String (Absolute filesystem path to a config in TOML format) | Sets the config file. If option is not given, fallbacks in descending order: 1. /etc/iceoryx/roudi_config.toml 2. hard-coded config. See [configuration guide](configuration-guide.md#dynamic-configuration) for information on the format. |

‎doc/website/concepts/architecture.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ This article provides an overview of the Eclipse iceoryx architecture and explai
66

77
The main packages which Eclipse iceoryx is composed of are depicted below.
88

9-
![Software layers](../images/iceoryx_software_layers_v2_0_0.svg)
9+
![Software layers](../images/iceoryx_software_layers_v3_0_0.svg)
1010

1111
The next sections briefly describe the components and their libraries one by one.
1212

1313
## Components and libraries
1414

1515
The different libraries and their namespaces are depicted below.
1616

17-
![Component diagram](../images/iceoryx_components_diagram_v2_0_0.svg)
17+
![Component diagram](../images/iceoryx_components_diagram_v3_0_0.svg)
1818

1919
### iceoryx hoofs
2020

‎doc/website/images/bosch-logo.png‎

8.69 KB
Loading

0 commit comments

Comments
 (0)