diff options
author | Sebastian Büttner <sebastian.buettner@softwareag.com> | 2022-01-14 17:08:38 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-14 17:08:38 +0100 |
commit | 477a913884e56ecbce2c85e99328e7fc8803fc31 (patch) | |
tree | fa5c0ea2fbcb7ea63eff1981a4c2c9ac8970ca38 | |
parent | ab0ecebdc1e17d6e29b897fe62c6ea2922aae8b6 (diff) |
Updated the Init system doc to the right term (#755)
-rw-r--r-- | docs/src/SUMMARY.md | 5 | ||||
-rw-r--r-- | docs/src/references/init-system-config.md (renamed from docs/src/references/system-config.md) | 20 |
2 files changed, 12 insertions, 13 deletions
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 77b43848..b489a495 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -37,9 +37,10 @@ - [Architecture](architecture/README.md) - [Thin Edge Json](architecture/thin-edge-json.md) - [The Mapper](architecture/mapper.md) - - [Software Management](./architecture/software-management.md) + - [Software Management](architecture/software-management.md) - [Architecture FAQ](architecture/faq.md) - [Platform support](supported-platforms.md) + - [Init System configuration](references/init-system-config.md) - [Write my own software management plugin](./tutorials/write-my-software-management-plugin.md) @@ -56,5 +57,3 @@ - [The `tedge connect` command](./references/tedge-connect.md) - [The `tedge disconnect` command](./references/tedge-disconnect.md) - [The `tedge mqtt` command](./references/tedge-mqtt.md) - -- [Configuration Reference](./references/system-config.md) diff --git a/docs/src/references/system-config.md b/docs/src/references/init-system-config.md index cf1815c5..87da17aa 100644 --- a/docs/src/references/system-config.md +++ b/docs/src/references/init-system-config.md @@ -1,7 +1,7 @@ -# System Configuration File +# Init System Configuration File -To support multiple system and service manager, `tedge` requires the `/etc/tedge/system.toml` file. -The file contains configurations about the system manager and the supported actions. +To support multiple init systems and service managers, `tedge` requires the `/etc/tedge/system.toml` file. +The file contains configurations about the init system and the supported actions. The format of the file is: @@ -33,11 +33,11 @@ will be interpreted as ## Keys -- **name**: An identifier of the system manager. +- **name**: An identifier of the init system. It is used in the output of `tedge connect` and `tedge disconnect`. -- **is_available**: The command to check if the system manager is available on your system. -- **restart**: The command to restart a service by the system manager. -- **stop**: The command to stop a service by the system manager. -- **enable**: The command to enable a service by the system manager. -- **disable**: The command to disable a service by the system manager. -- **is_active**: The command to check if the service is running by the system manager. +- **is_available**: The command to check if the init is available on your system. +- **restart**: The command to restart a service by the init system. +- **stop**: The command to stop a service by the init system. +- **enable**: The command to enable a service by the init system. +- **disable**: The command to disable a service by the init system. +- **is_active**: The command to check if the service is running by the init system. |