diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-01-12 18:17:50 +0100 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-01-12 18:54:17 +0100 |
commit | b2eea3dc325e8bcf680e09e08488600380334000 (patch) | |
tree | 4d310360172e6d1cbe11573e4d597a6a2d0a7ce0 /docs/PORTABILITY_AND_STABILITY.md | |
parent | docs: import "interface stability promise" (diff) | |
download | systemd-b2eea3dc325e8bcf680e09e08488600380334000.tar.xz systemd-b2eea3dc325e8bcf680e09e08488600380334000.zip |
docs: say that all documented programs in $PATH are stable
Diffstat (limited to 'docs/PORTABILITY_AND_STABILITY.md')
-rw-r--r-- | docs/PORTABILITY_AND_STABILITY.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/PORTABILITY_AND_STABILITY.md b/docs/PORTABILITY_AND_STABILITY.md index 6bc55d7177..ee771592b6 100644 --- a/docs/PORTABILITY_AND_STABILITY.md +++ b/docs/PORTABILITY_AND_STABILITY.md @@ -11,7 +11,7 @@ systemd provides various interfaces developers and programs might rely on. Start The stable interfaces are: * **The unit configuration file format**. Unit files written now will stay compatible with future versions of systemd. Extensions to the file format will happen in a way that existing files remain compatible. -* **The command line interface** of systemctl, loginctl, journalctl. We will make sure that scripts invoking these commands will continue to work with future versions of systemd. Note however that the output generated by these commands is generally not included in the promise, unless it is documented in the man page. Example: the output of "systemctl status" is not stable, but the one of "systemctl show" is, because the former is intended to be human readable and the latter computer readable, and this is documented in the man page. +* **The command line interface** of `systemd`, `systemctl`, `loginctl`, `journalctl`, and all other command line utilities installed in `$PATH` and documented in a man page. We will make sure that scripts invoking these commands will continue to work with future versions of systemd. Note however that the output generated by these commands is generally not included in the promise, unless it is documented in the man page. Example: the output of `systemctl status` is not stable, but that of `systemctl show` is, because the former is intended to be human readable and the latter computer readable, and this is documented in the man page. * **The protocol spoken on the socket referred to by $NOTIFY_SOCKET**, as documented in (sd_notify(3))[https://www.freedesktop.org/software/systemd/man/sd_notify.html]. * Some of the **"special" unit names** and their semantics. To be precise the ones that are necessary for normal services, and not those required only for early boot and late shutdown, with very few exceptions. To list them here: `basic.target`, `shutdown.target`, `sockets.target`, `network.target`, `getty.target`, `graphical.target`, `multi-user.target`, `rescue.target`, `emergency.target`, `poweroff.target`, `reboot.target`, `halt.target`, `runlevel[1-5].target`. * For a more comprehensive and authoritative list, consult the chart below. @@ -24,7 +24,7 @@ The following interfaces will not necessarily be kept stable for now, but we wil The following interfaces are considered private to systemd, and are not and will not be covered by any stability promise: -* **Undocumented switches** to systemd, systemctl and otherwise. +* **Undocumented switches** to `systemd`, `systemctl` and otherwise. * **The internal protocols** used on the various sockets such as the sockets `/run/systemd/shutdown`, `/run/systemd/private`. One of the main goals of systemd is to unify basic Linux configurations and service behaviors across all distributions. Systemd project does not contain any distribution-specific parts. Distributions are expected to convert over time their individual configurations to the systemd format, or they will need to carry and maintain patches in their package if they still decide to stay different. |