-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc/dbus: each documented interface goes to a separate .doc.xml file
- Loading branch information
Showing
3 changed files
with
68 additions
and
61 deletions.
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
doc/dbus/bus/org.opensuse.Agama.Storage1.Proposal.Calculator.bus.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
org.opensuse.Agama.Storage1.bus.xml |
67 changes: 67 additions & 0 deletions
67
doc/dbus/org.opensuse.Agama.Storage1.Proposal.Calculator.doc.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
<node name="/org/opensuse/Agama/Storage1"> | ||
<node name="zfcp_controllers" /> | ||
<node name="zfcp_disks" /> | ||
<!-- | ||
Interface for calculating a new storage proposal. | ||
--> | ||
<interface name="org.opensuse.Agama.Storage1.Proposal.Calculator"> | ||
<!-- | ||
Gets the default values for a volume with the given mount path. | ||
--> | ||
<method name="DefaultVolume"> | ||
<!-- | ||
E.g., /home | ||
--> | ||
<arg name="mount_path" direction="in" type="s"/> | ||
<!-- | ||
MountPath s | ||
MountOptions as | ||
TargetDevice s | ||
TargetVG s | ||
FsType s | ||
MinSize t | ||
MaxSize t (optinal, max size is considered as unlimited if omitted) | ||
AutoSize b | ||
Snapshots b | ||
Outline a{sv} | ||
Required b | ||
FsTypes as | ||
SupportAutoSize b | ||
SnapshotsConfigurable b | ||
SnapshotsAffectSizes b | ||
SizeRelevantVolumes as | ||
--> | ||
<arg name="volume" direction="out" type="a{sv}"/> | ||
</method> | ||
<!-- | ||
Calculates a new proposal. | ||
--> | ||
<method name="Calculate"> | ||
<!-- | ||
BootDevice s | ||
LVM b | ||
SystemVGDevices as | ||
EncryptionPassword s | ||
EncryptionMethod s | ||
EncryptionPBKDFunction s | ||
SpacePolicy s | ||
SpaceActions a{ss} | ||
Volumes aa{sv} | ||
List of volumes to create. The values for each volume are the same as the values returned | ||
by DefaultVolume method. The Outline (if given) would be ignored. | ||
--> | ||
<arg name="settings" direction="in" type="a{sv}"/> | ||
<arg name="result" direction="out" type="u"/> | ||
</method> | ||
<property type="ao" name="AvailableDevices" access="read"/> | ||
<!-- | ||
Relevant mount points for the selected product. Normally, the product defines some specific | ||
values for these mount points (e.g., min and max sizes, file system type, etc). | ||
--> | ||
<property type="as" name="ProductMountPoints" access="read"/> | ||
<property type="o" name="Result" access="read"/> | ||
</interface> | ||
|
||
</node> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters