diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ceac63b65..8f923888d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,14 @@ -# Contributing to Vector SIL Kit +# Contributing to the SIL Kit Project -Welcome and thank you for your interest in contributing to the Vector SIL Kit +Welcome and thank you for your interest in contributing to the SIL Kit open source project. +Since January 2026, SIL Kit is engineered and maintained by Vector and Synopsys in collaboration. -We are sorry, but at the moment, we do not accept external contributions until -we have established a contribution process. We're working behind the scenes to -get this ready in the future. Until then, we would kindly ask you to not open pull -requests. +We are sorry, but at the moment, we do not accept external contributions until we have established a contribution process. +However, you can contribute to the open-source project by creating an issue to discuss bugs or feature requests in public. + +We're working behind the scenes to get this ready in the future. +Until then, we would kindly ask you to not open pull requests. We will update this document when we are ready for your submissions. Thank you and stay tuned! diff --git a/README.rst b/README.rst index f149fcc95..c63f1d71f 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ ================================ -The Vector SIL Kit +The SIL Kit Project ================================ .. |VectorSite| image:: https://img.shields.io/badge/vector-sil--kit-red :target: https://vector.com/sil-kit @@ -26,11 +26,11 @@ The Vector SIL Kit | |AsanBadge| |UbsanBadge| |TsanBadge| |Linux/Arm64| | |WinBadge| -The Vector SIL Kit is an open-source library for connecting Software-in-the-Loop Environments. -This README is intended to provide you with quick start on how to build the Vector SIL Kit. +The SIL Kit is an open-source library for connecting Software-in-the-Loop Environments. +This README is intended to provide you with quick start on how to build the SIL Kit. -For documentation on using the Vector SIL Kit, see the HTML documentation, -which can be generated when building the Vector SIL Kit (cf. Customizing the +For documentation on using the SIL Kit, see the HTML documentation, +which can be generated when building the SIL Kit (cf. Customizing the Build) and is provided in pre-built form with the SIL Kit packages. The SIL Kit source and documentation is licensed under a permissible open @@ -54,7 +54,7 @@ The SIL Kit ecosystem comprises the following turn-key solutions: project provides first-class support for TAP devices of the host operating system. * The `SIL Kit Adapter for virtual CAN `_ - can be used to attach a virtual CAN interface (SocketCAN) to a Vector SIL Kit CAN bus. + can be used to attach a virtual CAN interface (SocketCAN) to a SIL Kit CAN bus. * The `SIL Kit Adapter for Generic Linux IO `_ allows to attach SIL Kit to a generic Linux IO device, such as character devices or GPIOs. @@ -99,7 +99,7 @@ directory and configure CMake:: cmake .. -3. Build the Vector SIL Kit +3. Build the SIL Kit ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Once the project has been generated, you can build the SIL Kit using the diff --git a/SilKit/source/SilKit.rc b/SilKit/source/SilKit.rc index 8fa68da88..6dadcc8df 100644 --- a/SilKit/source/SilKit.rc +++ b/SilKit/source/SilKit.rc @@ -6,7 +6,7 @@ #define VERSIONSTRING(a,b,c,d) STRING_HELPER(a) "." STRING_HELPER(b) "." STRING_HELPER(c) "." STRING_HELPER(d) #define ASSEMBLYINFO_COMPANY "Vector Informatik GmbH" -#define ASSEMBLYINFO_PRODUCT "Vector SIL Kit" +#define ASSEMBLYINFO_PRODUCT "SIL Kit" #define ASSEMBLYINFO_COPYRIGHT "Copyright © 2022 Vector Informatik GmbH." #define ASSEMBLYINFO_FILEDESCRIPTION "Vector SIL Kit by Vector Informatik GmbH" #define ASSEMBLYINFO_VERSIONSTRING VERSIONSTRING(SILKIT_VERSION_MAJOR,SILKIT_VERSION_MINOR,SILKIT_VERSION_PATCH,SILKIT_BUILD_NUMBER) @@ -38,7 +38,7 @@ BEGIN VALUE "CompanyName", ASSEMBLYINFO_COMPANY VALUE "FileDescription", ASSEMBLYINFO_FILEDESCRIPTION VALUE "FileVersion", ASSEMBLYINFO_VERSIONSTRING - VALUE "InternalName", "Vector SIL Kit" + VALUE "InternalName", "SIL Kit" VALUE "LegalCopyright", ASSEMBLYINFO_COPYRIGHT VALUE "OriginalFilename", "SilKit.dll" VALUE "ProductName", ASSEMBLYINFO_PRODUCT diff --git a/Utilities/SilKitMonitor/PassiveSystemMonitor.cpp b/Utilities/SilKitMonitor/PassiveSystemMonitor.cpp index 83730c6f4..84c3f4a56 100644 --- a/Utilities/SilKitMonitor/PassiveSystemMonitor.cpp +++ b/Utilities/SilKitMonitor/PassiveSystemMonitor.cpp @@ -82,7 +82,7 @@ int main(int argc, char** argv) commandlineParser.Add("sync", "s", "[--sync]", "-s, --sync: Run with virtual time synchronization."); - std::cout << "Vector SIL Kit -- System Monitor, SIL Kit version: " << SilKit::Version::String() << std::endl + std::cout << "SIL Kit -- System Monitor, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl; try @@ -116,7 +116,7 @@ int main(int argc, char** argv) std::string hash{SilKit::Version::GitHash()}; auto shortHash = hash.substr(0, 7); std::cout << "Version Info:" << std::endl - << " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl; + << " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl; return 0; } diff --git a/Utilities/SilKitRegistry/Registry.cpp b/Utilities/SilKitRegistry/Registry.cpp index 95f03f752..01c5bde9a 100644 --- a/Utilities/SilKitRegistry/Registry.cpp +++ b/Utilities/SilKitRegistry/Registry.cpp @@ -351,7 +351,7 @@ int main(int argc, char** argv) "-W, --windows-service: Run as a Windows service.", CliParser::Hidden); } - std::cout << "Vector SIL Kit -- Registry, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl; + std::cout << "SIL Kit -- Registry, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl; try { @@ -403,7 +403,7 @@ int main(int argc, char** argv) std::string hash{SilKit::Version::GitHash()}; auto shortHash = hash.substr(0, 7); std::cout << "Version Info:" << std::endl - << " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl; + << " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl; return 0; } diff --git a/Utilities/SilKitSystemController/SystemController.cpp b/Utilities/SilKitSystemController/SystemController.cpp index e350b1799..baa16bfc6 100644 --- a/Utilities/SilKitSystemController/SystemController.cpp +++ b/Utilities/SilKitSystemController/SystemController.cpp @@ -311,7 +311,7 @@ int main(int argc, char** argv) "--non-interactive: Run without awaiting any user interactions at any time.", CliParser::Hidden); - std::cout << "Vector SIL Kit -- System Controller, SIL Kit version: " << SilKit::Version::String() << std::endl + std::cout << "SIL Kit -- System Controller, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl; try @@ -345,7 +345,7 @@ int main(int argc, char** argv) std::string hash{SilKit::Version::GitHash()}; auto shortHash = hash.substr(0, 7); std::cout << "Version Info:" << std::endl - << " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl; + << " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl; return 0; } diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 048d2a552..c243dd702 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -4,7 +4,7 @@ {% extends "!layout.html" %} {% block sidebartitle %} - Vector SIL Kit + SIL Kit
Version: {{ release }} diff --git a/docs/api/api.rst b/docs/api/api.rst index a85eac247..d1a806145 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -4,7 +4,7 @@ C/C++ API ========= -This document describes the user available programming interfaces of the Vector |ProductName|. +This document describes the user available programming interfaces of the |ProductName|. If you are not yet familiar with the |ProductName|, have a look at the :doc:`Developers Guide<../for-developers/developers>`. Information on API organization in the |ProductName|: diff --git a/docs/changelog/overview.rst b/docs/changelog/overview.rst index 06a47dab4..ee1113264 100644 --- a/docs/changelog/overview.rst +++ b/docs/changelog/overview.rst @@ -1,7 +1,7 @@ Changelog ========= -All notable changes to the Vector SIL Kit project are listed on the respective +All notable changes to the SIL Kit project are listed on the respective versions page. .. toctree:: diff --git a/docs/conf.py b/docs/conf.py index d092c2d39..500ab3e9a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- -project = 'Vector SIL Kit' +project = 'SIL Kit' copyright = '2022 Vector Informatik GmbH' author = 'Vector Informatik GmbH' version = '1.0.0' diff --git a/docs/configuration/configuration.rst b/docs/configuration/configuration.rst index 0c4388df0..f5f178b92 100644 --- a/docs/configuration/configuration.rst +++ b/docs/configuration/configuration.rst @@ -6,7 +6,7 @@ Configuration .. _sec:sil-kit-config-yaml: -The Vector |ProductName| provides optional configuration to enhance flexibility and control through use of YAML files. +The |ProductName| provides optional configuration to enhance flexibility and control through use of YAML files. This allows users to modify behavior without recompiling source code. Further, it allows configuration of services which are inactive by default, such as tracing and logging. Different configuration options are available for |ProductName| participants and the |ProductName| Registry. @@ -202,7 +202,7 @@ The Registry Configuration File An instance of the |ProductName| Registry (``sil-kit-registry(.exe)``) can be configured via a YAML file. The configuration file is optional and overrides the settings specified on the command line. -It also allows extended configuration, beyond what the command line allows, particularly for logging and data export to a `Vector SIL Kit Dashboard `_ instance. +It also allows extended configuration, beyond what the command line allows, particularly for logging and data export to a `SIL Kit Dashboard `_ instance. The outline of a registry configuration file is as follows: diff --git a/docs/configuration/experimental-configuration.rst b/docs/configuration/experimental-configuration.rst index 421ef5937..8a408521e 100644 --- a/docs/configuration/experimental-configuration.rst +++ b/docs/configuration/experimental-configuration.rst @@ -91,7 +91,7 @@ Metrics for the registry The registry configuration supports collecting metrics from remote participants and forwarding the collected data to the SIL Kit Dashboard for further analysis and visualization. -Refer to the documentation of the `Vector SIL Kit Dashboard `_ for further instructions. +Refer to the documentation of the `SIL Kit Dashboard `_ for further instructions. .. code-block:: yaml diff --git a/docs/configuration/extension-configuration.rst b/docs/configuration/extension-configuration.rst index 5f9be0846..b36be901e 100644 --- a/docs/configuration/extension-configuration.rst +++ b/docs/configuration/extension-configuration.rst @@ -13,7 +13,7 @@ Extensions Configuration Overview ======================================== -The Vector SIL Kit Extensions are developed by Vector and provided in binary form. +The SIL Kit Extensions are developed by Vector and provided in binary form. To facilitate the lookup of these binaries, specific search paths can be configured as explained below. Configuration diff --git a/docs/configuration/logging-configuration.rst b/docs/configuration/logging-configuration.rst index 0bd985840..1a041522a 100644 --- a/docs/configuration/logging-configuration.rst +++ b/docs/configuration/logging-configuration.rst @@ -12,13 +12,13 @@ Logging Configuration Overview ======================================== -Within the Vector SIL Kit, the Logger provides features for local and distributed logging on different log +Within the SIL Kit, the Logger provides features for local and distributed logging on different log levels. Configuration ======================================== The Logging configuration allows to configure the logging behavior of the simulation participant. -Within the Vector SIL Kit, the Logger uses so-called sinks to store log messages. +Within the SIL Kit, the Logger uses so-called sinks to store log messages. Multiple sinks can be configured at the same time. For example, to send log messages with log level ``Debug`` or higher to a remote logger and write ``Trace`` level logs to a file, the following configuration could be used: diff --git a/docs/configuration/middleware-configuration.rst b/docs/configuration/middleware-configuration.rst index a9b609589..0fbec20c1 100644 --- a/docs/configuration/middleware-configuration.rst +++ b/docs/configuration/middleware-configuration.rst @@ -14,8 +14,8 @@ Middleware Configuration Overview -------------------- -The Vector SIL Kit uses an internal middleware for message exchange. -This middleware is open source and included in the sources of the Vector SIL Kit. +The SIL Kit uses an internal middleware for message exchange. +This middleware is open source and included in the sources of the SIL Kit. The middleware can be configured as follows. diff --git a/docs/configuration/services-configuration.rst b/docs/configuration/services-configuration.rst index 8c67f2dbd..0aeb1e6b0 100644 --- a/docs/configuration/services-configuration.rst +++ b/docs/configuration/services-configuration.rst @@ -9,7 +9,7 @@ Communication Services (CAN, LIN, FlexRay, Ethernet, Data, RPC) Overview ======================================== -All services of the Vector SIL Kit can be configured within the participant configuration. +All services of the SIL Kit can be configured within the participant configuration. The following sections describe how each service can be configured. The configuration of the single services is fully optional. diff --git a/docs/faq/faq.rst b/docs/faq/faq.rst index 4ad15614f..3fe3e4c95 100644 --- a/docs/faq/faq.rst +++ b/docs/faq/faq.rst @@ -51,10 +51,10 @@ The registry does not partake in the simulation itself. It especially does not route messages between participants. Please note that it is mandatory that all |ProductName| simulation participants can reach the |ProductName| registry for a proper simulation setup. -Can I use Vector |ProductName| together with real hardware/in a Hardware-in-the-Loop setup? +Can I use |ProductName| together with real hardware/in a Hardware-in-the-Loop setup? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Vector |ProductName| was designed deliberately with Software-in-the-Loop environments in mind. +|ProductName| was designed deliberately with Software-in-the-Loop environments in mind. Many aspects of it are designed for SIL settings (especially the virtual time synchronization, that adapts its speed to the execution speed of the participants) and not HIL settings. These aspects might imply that |ProductName| does not fit the needs of your hardware setup. Furthermore, |ProductName| itself does not provide capabilities to connect it to a hardware setup. diff --git a/docs/for-developers/developers.rst b/docs/for-developers/developers.rst index e811640e6..aef4816f8 100644 --- a/docs/for-developers/developers.rst +++ b/docs/for-developers/developers.rst @@ -4,7 +4,7 @@ Developer Guide ============================= -The following sections explain, how to consume the Vector |ProductName| library in your own application and how to use the |ProductName| API to communicate with other participants of a simulation. +The following sections explain, how to consume the |ProductName| library in your own application and how to use the |ProductName| API to communicate with other participants of a simulation. .. contents:: :local: diff --git a/docs/for-users/users.rst b/docs/for-users/users.rst index 7c8a2dd87..0fc0a8386 100644 --- a/docs/for-users/users.rst +++ b/docs/for-users/users.rst @@ -4,7 +4,7 @@ User Guide ============================== -The following section explains how to bring together Vector |ProductName| enabled applications and how to successfully run a simulation. +The following section explains how to bring together |ProductName| enabled applications and how to successfully run a simulation. .. contents:: :local: diff --git a/docs/man/sil-kit-monitor.1 b/docs/man/sil-kit-monitor.1 index 49f95cf01..7a1f3c5f4 100644 --- a/docs/man/sil-kit-monitor.1 +++ b/docs/man/sil-kit-monitor.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1. .TH sil-kit-monitor "1" "September 2024" "sil-kit-monitor" "User Commands" .SH NAME -sil-kit-monitor \- Manual page for Vector SIL Kit - System Monitor +sil-kit-monitor \- Manual page for SIL Kit - System Monitor .SH SYNOPSIS .B sil-kit-monitor [\fI\,--version\/\fR] [\fI\,--help\/\fR] [\fI\,--connect-uri \/\fR] [\fI\,--name \/\fR] [\fI\,--configuration \/\fR] [\fI\,--autonomous\/\fR] [\fI\,--coordinated\/\fR] [\fI\,--sync\/\fR] .SH DESCRIPTION -Vector SIL Kit \fB\-\-\fR System Monitor +SIL Kit \fB\-\-\fR System Monitor .PP .SH SYNOPSIS .IP "-v --version" @@ -28,7 +28,6 @@ Run with virtual time synchronization. .SH "SEE ALSO" The full documentation for .I sil-kit-monitor -.B Vector is maintained at .B https://vectorgrp.github.io/sil-kit-docs/ .SH COPYRIGHT diff --git a/docs/man/sil-kit-registry.1 b/docs/man/sil-kit-registry.1 index 293e49e70..78992bb1e 100644 --- a/docs/man/sil-kit-registry.1 +++ b/docs/man/sil-kit-registry.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1. .TH sil-kit-registry "1" "September 2024" "sil-kit-registry" "User Commands" .SH NAME -sil-kit-registry \- Manual page for Vector SIL Kit - Registry +sil-kit-registry \- Manual page for SIL Kit - Registry .SH SYNOPSIS .B sil-kit-registry [\fI\,--version\/\fR] [\fI\,--help\/\fR] [\fI\,--listen-uri \/\fR] [\fI\,--generate-configuration \/\fR] [\fI\,--dashboard-uri \/\fR] [\fI\,--log \/\fR] [\fI\,--registry-configuration \/\fR] .SH DESCRIPTION -Vector SIL Kit \fB\-\-\fR Registry +SIL Kit \fB\-\-\fR Registry .PP .SH OPTIONS .IP "-v --version" diff --git a/docs/man/sil-kit-system-controller.1 b/docs/man/sil-kit-system-controller.1 index 9b32c04fb..331198c3a 100644 --- a/docs/man/sil-kit-system-controller.1 +++ b/docs/man/sil-kit-system-controller.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1. .TH sil-kit-system-controller "1" "September 2024" "sil-kit-system-controller" "User Commands" .SH NAME -sil-kit-system-controller \- Manual page for Vector SIL Kit - System Controller +sil-kit-system-controller \- Manual page for SIL Kit - System Controller .SH SYNOPSIS .B sil-kit-system-controller [\fI\,--version\/\fR] [\fI\,--help\/\fR] [\fI\,--non-interactive\/\fR] [\fI\,--connect-uri \/\fR] [\fI\,--name \/\fR] [\fI\,--configuration \/\fR] \fI\, \/\fR[\fI\, \/\fR...] .SH DESCRIPTION -Vector SIL Kit \fB\-\-\fR System Controller +SIL Kit \fB\-\-\fR System Controller .PP Arguments: .IP "-v --version" diff --git a/docs/overview/overview.rst b/docs/overview/overview.rst index bed68d2a5..a91990af1 100644 --- a/docs/overview/overview.rst +++ b/docs/overview/overview.rst @@ -1,7 +1,7 @@ .. include:: substitutions.rst ======================= -Vector SIL Kit Overview +SIL Kit Overview ======================= .. |_| unicode:: 0xA0 @@ -15,7 +15,7 @@ Vector SIL Kit Overview .. |Timesync-API| replace:: :ref:`time synchronization` .. |Logging-API| replace:: :ref:`logging` -The Vector |ProductName| is an open source library for connecting Software-in-the-Loop Environments. +The |ProductName| is an open source library for connecting Software-in-the-Loop Environments. It provides: * Communication infrastructure for automotive and non-automotive applications @@ -101,7 +101,7 @@ The |ProductName| ecosystem comprises the following turn-key solutions: project provides first-class support for TAP devices of the host operating system. * The `SIL Kit Adapter for virtual CAN `_ - can be used to attach a virtual CAN (Controller Area Network) interface (SocketCAN) to a Vector SIL Kit CAN bus. + can be used to attach a virtual CAN (Controller Area Network) interface (SocketCAN) to a SIL Kit CAN bus. * The `SIL Kit Adapter for Generic Linux IO `_ allows to attach SIL Kit to a generic Linux IO device, such as character devices or GPIOs. diff --git a/docs/troubleshooting/advanced.rst b/docs/troubleshooting/advanced.rst index d2e1457c8..a1d209598 100644 --- a/docs/troubleshooting/advanced.rst +++ b/docs/troubleshooting/advanced.rst @@ -1,7 +1,7 @@ Advanced ======== -This section shows how to use advanced tools like the `Vector SIL Kit Dashboard `_ to visualize simulations, in order to identitfy participant misconfigurations, detect system misbehavior or analyze participant performance. +This section shows how to use advanced tools like the `SIL Kit Dashboard `_ to visualize simulations, in order to identitfy participant misconfigurations, detect system misbehavior or analyze participant performance. Getting Started with the dashboard ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -9,10 +9,10 @@ The dashboard is a freeware application that collects and visualizes SIL Kit sim It can be used to show static attributes of participants and also show their simulation properties like active peer connections and simulated, active networks. In addition, the collection of performance metrics can be enabled in the configuration files of the SIL Kit participants. -This section shows how to enable the data collection of simulations for the Vector SIL Kit Dashboard. +This section shows how to enable the data collection of simulations for the SIL Kit Dashboard. Please refer to the SIL Kit Dashboard documentation for updated instructions. -#. The SIL Kit registry will forward simulation data to a running Vector SIL Kit Dashboard instance, if configured properly. +#. The SIL Kit registry will forward simulation data to a running SIL Kit Dashboard instance, if configured properly. The ``sil-kit-registry`` executable supports the ``--dashboard-uri https://1.2.3.4`` command line flag and the registry's configuration supports the ``DashboardUri: https://1.2.3.4`` declaration. Ensure that the registry is able to connect to the Dashboard when started, e.g. by verifying the log output. The registry's configuration of ``CollectFromRemotes: true`` defaults to true -- it can be disabled explicitly. diff --git a/docs/utilities/utilities.rst b/docs/utilities/utilities.rst index a9dd47a7f..bc22a8b0a 100644 --- a/docs/utilities/utilities.rst +++ b/docs/utilities/utilities.rst @@ -8,7 +8,7 @@ Utilities :local: :depth: 1 -Running a Vector |ProductName| system is supported by several utilities. +Running a |ProductName| system is supported by several utilities. The **Registry** is a mandatory part of the |ProductName| integrated middleware. It is needed to establish the connections between simulation participants at the start of a simulation. The **System Controller** implements a simulation-wide state handling. @@ -25,7 +25,7 @@ sil-kit-registry Abstract The ``sil-kit-registry`` enables discovery between |ProductName| participants. - It is needed for Vector |ProductName| simulations. + It is needed for |ProductName| simulations. Source location ``Utilities/SilKitRegistry`` Requirements