Skip to content

Commit

Permalink
docs: Update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
KonradBkd committed Oct 15, 2024
1 parent 33d6b5b commit 7f45b76
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,15 @@ All notable changes to the Vector SIL Kit project shall be documented in this fi

The format is based on `Keep a Changelog (http://keepachangelog.com/en/1.0.0/) <http://keepachangelog.com/en/1.0.0/>`_.

[4.0.54] - Unreleased
---------------------

Changed
~~~~~~~

- Revised the documentation (demos, troubleshooting, doxygen output, file structure)

[4.0.53] - UNRELEASED
[4.0.53] - 2024-10-11
---------------------

Changed
Expand All @@ -17,18 +24,24 @@ Changed

All utilities listen to OS signals to detect termination request.

- Old: Monitor and Registry wait for the user to press `[Enter]`` to shutdown.
- New: Monitor and Registry can be requested to shutdown via ``[Ctrl]-[C]``. Registry option '-s, --use-signal-handler' is deprecated.
- Old: Monitor and Registry wait for the user to press ``[Enter]`` to shutdown.
- New: Monitor and Registry can be requested to shutdown via ``[Ctrl]-[C]``. Registry option ``-s, --use-signal-handler`` is deprecated.

All utilities no longer require user interaction.

- Old: Registry, Monitor and System Controller prompt the user by default to press `[Enter]`` to end process after shutdown.
- New: All utilities terminate without prompting for user input. SystemController option '-ni, --non-interactive' is deprecated.
- Old: Registry, Monitor and System Controller prompt the user by default to press ``[Enter]`` to end process after shutdown.
- New: All utilities terminate without prompting for user input. SystemController option ``-ni, --non-interactive`` is deprecated.

- The Logger now adds the participant's name (as a normalized string) to the user-defined ``LogName`` for file sinks.

- Implemented the union (de-)serialization stubs in the ``silkit/util/serdes`` headers.

- Revised the documentation (demos, troubleshooting, doxygen output, file structure)
Fixed
~~~~~

- If using the ``SimStepHandlerAsync``, the log message that reports the end of the simulation step is now printed after the call to ``CompleteSimulationStep``.

- Fixed an issue with the NetSim API that caused an exception when used with log level ``trace``.

[4.0.52] - 2024-09-02
---------------------
Expand Down Expand Up @@ -1599,7 +1612,7 @@ Changed
The command line tools were updated to accept a new parameter for this.
- The command line tools were modified to use lower case names with dashes:
E.g., the ``IbRegistry`` is now called ``sil-kit-registry``.
See :doc:`./utilities/utilities` for details.
See :doc:`./usage/utilities` for details.

- The trivial simulation and the detailed simulation have been made more consistent:

Expand Down Expand Up @@ -3988,7 +4001,7 @@ Removed
Changed
~~~~~~~

- Updated documentation of :doc:`./demos/demos`, :doc:`./utilities/utilities` and :doc:`./configuration/configuration`
- Updated documentation of :doc:`./usage/demos`, :doc:`./usage/utilities` and :doc:`./configuration/configuration`


- Participant (formerly 'ComAdapter') methods to create DataPublisher, DataSubscriber, RpcClient and RpcServer now have an additional
Expand Down Expand Up @@ -6383,17 +6396,17 @@ This is a Quality Assured Release.

Added
~~~~~
- Documentation for the CAN controller API: :doc:`CAN Vehicle Network Controllers <api/services/can>`.
- Documentation for the CAN controller API: :doc:`CAN Vehicle Network Controllers <api/can>`.
- Documentation for the Participant Controller API: :ref:`changelog-outdated-reference` (``api/participantcontroller``) (AFTMAGT-206).
- Documentation for the IO Port services (AFTMAGT-201).
- Documented Generic Messages API: (AFTMAGT-204).
- Documented the simulation state machine and synchronization types: :doc:`simulation/simulation`
- Added docs for the ComAdapter:
- Added quick start guide: usage/quickstart
- Elaborate the user APIs and overview pages: :doc:`api/api`
- Add docs for :doc:`api/system-utilities/systemcontroller` (AFTMAGT-242).
- Add docs for :doc:`api/system-utilities/systemmonitor` (AFTMAGT-242).
- Add docs for :doc:`api/services/ethernet` (AFTMAGT-239).
- Add docs for :doc:`api/systemcontroller` (AFTMAGT-242).
- Add docs for :doc:`api/systemmonitor` (AFTMAGT-242).
- Add docs for :doc:`api/ethernet` (AFTMAGT-239).

Changed
~~~~~~~
Expand Down Expand Up @@ -6677,7 +6690,7 @@ Changed
- The LIN API was redesigned to provide a clearer and simpler interface. To make
the transition to the new API as simple as possible, we provided extensive
documentation on the new API itself including usage examples and information
about what changed in the new API: :doc:`../api/services/lin`
about what changed in the new API: :doc:`../api/lin`
- Removed spdlog from the public IB API. Spdlog is still used internally but it
has been removed from the public API to avoid conflicts with user specific
spdlog installations.
Expand Down

0 comments on commit 7f45b76

Please sign in to comment.