Skip to content

Commit 1f1e921

Browse files
committed
doc: avoid super long line in netplan-dbus.md
Thanks lintian!
1 parent 2e8fa56 commit 1f1e921

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

doc/netplan-dbus.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,14 @@ The ``/io/netplan/Netplan/config/<ID>`` objects provide a ``io.netplan.Netplan.C
2727
* ``Get() -> s``: calls **netplan get --root-dir=/run/netplan/config-ID all** and returns the merged YAML config of the the given config object's state
2828
* ``Set(s:CONFIG_DELTA, s:ORIGIN_HINT) -> b``: calls **netplan set --root-dir=/run/netplan/config-ID --origin-hint=ORIGIN_HINT CONFIG_DELTA**
2929

30-
CONFIG_DELTA can be something like: ``network.ethernets.eth0.dhcp4=true`` and ORIGIN_HINT can be something like: ``70-snapd`` (it will then write the config to ``70-snapd.yaml``). Once ``Set()`` is called on a config object, all other current and future config objects are being invalidated and cannot ``Set()`` or ``Try()/Apply()`` anymore, due to this pending dirty state. After the dirty config object is rejected via ``Cancel()``, the other config objects are valid again. If the dirty config object is accepted via ``Apply()``, newly created config objects will be valid, while the older states will stay invalid.
30+
CONFIG_DELTA can be something like: ``network.ethernets.eth0.dhcp4=true`` and
31+
ORIGIN_HINT can be something like: ``70-snapd`` (it will then write the config
32+
to ``70-snapd.yaml``). Once ``Set()`` is called on a config object, all other
33+
current and future config objects are being invalidated and cannot ``Set()`` or
34+
``Try()/Apply()`` anymore, due to this pending dirty state. After the dirty
35+
config object is rejected via ``Cancel()``, the other config objects are valid
36+
again. If the dirty config object is accepted via ``Apply()``, newly created
37+
config objects will be valid, while the older states will stay invalid.
3138

3239
* ``Try(u:TIMEOUT_SEC) -> b``: replaces the main netplan configuration with this config object's state and calls **netplan try --timeout=TIMEOUT_SEC**
3340
* ``Cancel() -> b``: rejects a currently running ``Try()`` attempt on this config object and/or discards the config object

0 commit comments

Comments
 (0)