Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#432] Implement CLI iox2-config #468

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

[#432] Add an abstraction layer to obtain the path to the configurati…

41d20b8
Select commit
Loading
Failed to load commit list.
Open

[#432] Implement CLI iox2-config #468

[#432] Add an abstraction layer to obtain the path to the configurati…
41d20b8
Select commit
Loading
Failed to load commit list.
Task list completed / task-list-completed Started 2024-11-27 12:36:25 ago

14 / 16 tasks completed

2 tasks still to be completed

Details

Required Tasks

Task Status
Create a new CLI for iceoryx2 : iox2-config Incomplete
iox2-config can show the configuration currently in use and generate a new configuration file at the default location iceoryx2 is looking for. Incomplete
Remove the print_system_configuration() function in iceoryx2-bb/posix/src/system_configuration.rs file and move it into the CLI iox2-config Incomplete
Add sensible notes for the reviewer Completed
PR title is short, expressive and meaningful Completed
Relevant issues are linked in the References section Completed
Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT Completed
Branch follows the naming format (iox2-123-introduce-posix-ipc-example) Completed
Commit messages have the issue ID ([#123] Add posix ipc example) Completed
Commit author matches [Eclipse Contributor Agreement][eca] (and ECA is signed) Completed
Tests follow the [best practice for testing][testing] Incomplete
Changelog updated [in the unreleased section][changelog] including API breaking changes Completed
Assign PR to reviewer Completed
All checks have passed (except task-list-completed) Completed
Commits are properly organized and messages are according to the guideline Completed
Unit tests have been written for new behavior Incomplete
Public API is documented Completed
PR title describes the changes Completed
All open points are addressed and tracked via issues Completed
a location was provided and the file was not there -> an error message is printed Incomplete
no location was provided and there is no file at the default locations -> a debug message is printed Incomplete
DEFAULT_CONFIG_FILE must be adjusted so that it searches all XDG paths. (no need to provide a specific location) Incomplete
If there is no configuration file: a debug printout is used and the built-in configuration is used. Incomplete
Swapping out an implementation to a safety-certifiable version Incomplete
Implementation of the concept for arbitrary environments that don't have a file system Incomplete