diff options
| author | Beniamino Galvani <bgalvani@redhat.com> | 2017-06-26 09:59:12 +0200 |
|---|---|---|
| committer | Beniamino Galvani <bgalvani@redhat.com> | 2017-06-26 09:59:35 +0200 |
| commit | 2b405c98fb40e2536d938bac5784a513e2bceac1 (patch) | |
| tree | 064fa4a4db744fc49bd0753d53dce5d021ac894f /introspection/org.freedesktop.NetworkManager.xml | |
| parent | 92fc10918337f45ef5eb80bb663a8916894110fe (diff) | |
| download | NetworkManager-2b405c98fb40e2536d938bac5784a513e2bceac1.tar.gz | |
introspection: slightly improve checkpoint documentation
Fix CheckpointCreate() arguments formatting, add link to create flags
and capitalize sentences.
Diffstat (limited to 'introspection/org.freedesktop.NetworkManager.xml')
| -rw-r--r-- | introspection/org.freedesktop.NetworkManager.xml | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/introspection/org.freedesktop.NetworkManager.xml b/introspection/org.freedesktop.NetworkManager.xml index ebd04a898b..73cbc7254a 100644 --- a/introspection/org.freedesktop.NetworkManager.xml +++ b/introspection/org.freedesktop.NetworkManager.xml @@ -213,11 +213,10 @@ <!-- CheckpointCreate: - - @devices: a list of device paths for which a checkpoint should be created. An empty list means all devices. - @rollback_timeout: the time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite. - @flags: optional flags that influence the creation. - @checkpoint: on success, returns the path of the checkpoint. + @devices: A list of device paths for which a checkpoint should be created. An empty list means all devices. + @rollback_timeout: The time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite. + @flags: (<link linkend="NMCheckpointCreateFlags">NMCheckpointCreateFlags</link>) Flags for the creation. + @checkpoint: On success, the path of the new checkpoint. Create a checkpoint of the current networking configuration for given interfaces. If @rollback_timeout is not zero, a @@ -232,7 +231,7 @@ <!-- CheckpointDestroy: - @checkpoint: the checkpoint to be destroyed. Set to empty to cancel all pending checkpoints. + @checkpoint: The checkpoint to be destroyed. Set to empty to cancel all pending checkpoints. Destroy a previously created checkpoint. --> @@ -242,8 +241,8 @@ <!-- CheckpointRollback: - @checkpoint: the checkpoint to be rolled back. - @result: on return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a <link linkend="NMRollbackResult">RollbackResult</link>. + @checkpoint: The checkpoint to be rolled back. + @result: On return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a <link linkend="NMRollbackResult">RollbackResult</link>. Rollback a checkpoint before the timeout is reached. --> |