include permissions and errors in the docs for the LinuxMdStart method

diff --git a/src/org.freedesktop.DeviceKit.Disks.xml b/src/org.freedesktop.DeviceKit.Disks.xml
index f403b99..93f518f 100644 (file)
--- a/src/org.freedesktop.DeviceKit.Disks.xml
+++ b/src/org.freedesktop.DeviceKit.Disks.xml
@@ -1,6 +1,33 @@
 <!DOCTYPE node PUBLIC
 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
-"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
+  <!ENTITY ERROR_GENERAL "org.freedesktop.DeviceKit.Disks.Device.GeneralError">
+  <!ENTITY ERROR_NO_SUCH_DEVICE "org.freedesktop.DeviceKit.Disks.Device.NoSuchDevice">
+  <!ENTITY ERROR_NOT_SUPPORTED "org.freedesktop.DeviceKit.Disks.Device.NotSupported">
+  <!ENTITY ERROR_NOT_MOUNTABLE "org.freedesktop.DeviceKit.Disks.Device.NotMountable">
+  <!ENTITY ERROR_MOUNTED "org.freedesktop.DeviceKit.Disks.Device.Mounted">
+  <!ENTITY ERROR_NOT_MOUNTED "org.freedesktop.DeviceKit.Disks.Device.NotMounted">
+  <!ENTITY ERROR_NOT_MOUNTED_BY_DK "org.freedesktop.DeviceKit.Disks.Device.NotMountedByDeviceKit">
+  <!ENTITY ERROR_FSTAB_ENTRY "org.freedesktop.DeviceKit.Disks.Device.FstabEntry">
+  <!ENTITY ERROR_MOUNT_OPTION_NOT_ALLOWED "org.freedesktop.DeviceKit.Disks.Device.MountOptionNotAllowed">
+  <!ENTITY ERROR_FILESYSTEM_BUSY "org.freedesktop.DeviceKit.Disks.Device.FilesystemBusy">
+  <!ENTITY ERROR_CANNOT_REMOUNT "org.freedesktop.DeviceKit.Disks.Device.CannotRemount">
+  <!ENTITY ERROR_UNMOUNT_OPTION_NOT_ALLOWED "org.freedesktop.DeviceKit.Disks.Device.UnmountOptionNotAllowed">
+  <!ENTITY ERROR_NO_JOB_IN_PROGRESS "org.freedesktop.DeviceKit.Disks.Device.NoJobInProgress">
+  <!ENTITY ERROR_JOB_ALREADY_IN_PROGRESS "org.freedesktop.DeviceKit.Disks.Device.JobAlreadyInProgress">
+  <!ENTITY ERROR_JOB_CANNOT_BE_CANCELLED "org.freedesktop.DeviceKit.Disks.Device.JobCannotBeCancelled">
+  <!ENTITY ERROR_JOB_WAS_CANCELLED "org.freedesktop.DeviceKit.Disks.Device.JobWasCancelled">
+  <!ENTITY ERROR_NOT_PARTITION "org.freedesktop.DeviceKit.Disks.Device.NotPartition">
+  <!ENTITY ERROR_NOT_PARTITIONED "org.freedesktop.DeviceKit.Disks.Device.NotPartitioned">
+  <!ENTITY ERROR_NOT_CRYPTO "org.freedesktop.DeviceKit.Disks.Device.NotCrypto">
+  <!ENTITY ERROR_CRYPTO_ALREADY_UNLOCKED "org.freedesktop.DeviceKit.Disks.Device.CryptoAlreadyUnlocked">
+  <!ENTITY ERROR_CRYPTO_NOT_UNLOCKED "org.freedesktop.DeviceKit.Disks.Device.CryptoNotUnlocked">
+  <!ENTITY ERROR_IS_BUSY "org.freedesktop.DeviceKit.Disks.Device.IsBusy">
+  <!ENTITY ERROR_NOT_DRIVE "org.freedesktop.DeviceKit.Disks.Device.NotDrive">
+  <!ENTITY ERROR_NOT_SMART_CAPABLE "org.freedesktop.DeviceKit.Disks.Device.NotSmartCapable">
+  <!ENTITY ERROR_NOT_LINUX_MD "org.freedesktop.DeviceKit.Disks.Device.NotLinuxMd">
+  <!ENTITY ERROR_NOT_LINUX_MD_COMPONENT "org.freedesktop.DeviceKit.Disks.Device.NotLinuxMdComponent">
+]>
 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
 
   <interface name="org.freedesktop.DeviceKit.Disks">
@@ -65,6 +92,21 @@
             components are given.
           </doc:para>
         </doc:description>
+        <doc:permission>
+          The caller will need one of the following PolicyKit authorizations:
+          <doc:list>
+            <doc:item>
+              <doc:term>org.freedesktop.devicekit.disks.linux-md</doc:term>
+              <doc:definition>Needed to configured Linux md Software RAID devices</doc:definition>
+            </doc:item>
+          </doc:list>
+        </doc:permission>
+        <doc:errors>
+          <doc:error name="&ERROR_NOT_LINUX_MD_COMPONENT;">one of the given components doesn't exist or is not a Linux md component</doc:error>
+          <doc:error name="&ERROR_IS_BUSY;">if one of the given components are busy</doc:error>
+          <doc:error name="&ERROR_GENERAL;">if incoming parameters are invalid or an unknown error occured</doc:error>
+          <doc:error name="&ERROR_JOB_WAS_CANCELLED;">if the job was cancelled</doc:error>
+        </doc:errors>
       </doc:doc>
     </method>