Skip to content

Commit baf1547

Browse files
mossmaurice-apexaimossmaurice-apexai
committed
iox-#1295 Address review findings fixing details in the new articles as well as release notes
1 parent d46678e commit baf1547

File tree

6 files changed

+1483
-1520
lines changed

6 files changed

+1483
-1520
lines changed

‎.lycheeignore‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,5 @@ https://github.com/eclipse-iceoryx/iceoryx/tree/vx.x.x
33
https://www.misra.org.uk/
44
https://www.gnu.org/software/screen/
55
https://www.etas.com/
6-
# Remove after v3.0 release
7-
https://github.com/eclipse-iceoryx/iceoryx/tree/v3.0.0
8-
https://github.com/eclipse-iceoryx/iceoryx/compare/v2.0.6...v3.0.0
96

107
[email protected]

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
The following bindings and extensions are available for iceoryx:
44

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-
| ara::com binding | Binding to use iceoryx in [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) |
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/roudi-command-line-arguments.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Command line arguments of RouDi
22

3-
To view the available command line options for RouDi call `$ICEORYX_ROOT/build/iox-roudi --help`.
3+
To view the available command line options for RouDi call `iox-roudi --help`.
44

55
| Short | Long | Parameter | Explanation |
66
|-------|---------------------|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
77
| -h | --help | None | Prints the available options |
88
| -v | --version | None | Prints the version string |
99
| -d | --domain-id | Unsigned integer | Sets the domain id. No communication can happen between different domains. Experimental feature! |
1010
| -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 enable RouDi terminates and kills unresponsive process. |
11+
| -m | --monitoring-mode | String (on, off) | Enables or disables the process alive monitoring feature. If enabled RouDi terminates and kills unresponsive process. |
1212
| -l | --log-level | String (off, fatal, error, warning, info, debug, trace) | Set the log level. Default log level is 'info'. |
1313
| -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! |
1414
| -t | --termination-delay | Unsigned integer | Sets the delay in seconds before RouDi sends SIGTERM to running applications at shutdown. Default is '0'. |
1515
| -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 YAML 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. |
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/release-notes/.pages‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
nav:
2-
- iceoryx-v3-0-0.md
32
- iceoryx-v2-0-6.md
43
- iceoryx-v2-0-5.md
54
- iceoryx-v2-0-4.md

0 commit comments

Comments
 (0)