diff options
| author | David Zeuthen <davidz@redhat.com> | 2012-02-23 18:16:06 -0500 |
|---|---|---|
| committer | David Zeuthen <davidz@redhat.com> | 2012-02-23 18:16:06 -0500 |
| commit | d28c5d25acff4fdbb39ff0297f29e95029db8edb (patch) | |
| tree | 057c783ada10048fd5a5f65c51b6108a09fc5ef9 | |
| parent | 00520f0aa7856e9322119c6afb84dc3f63325423 (diff) | |
Add a section about /org/freedesktop/UDisks2/block_devices/* objects
Signed-off-by: David Zeuthen <davidz@redhat.com>
| -rw-r--r-- | doc/udisks2-docs.xml | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/udisks2-docs.xml b/doc/udisks2-docs.xml index 0114a87..e5e9c0c 100644 --- a/doc/udisks2-docs.xml +++ b/doc/udisks2-docs.xml @@ -56,6 +56,33 @@ manipulate global state. </para> </sect1> + <sect1 id="ref-dbus-block-devices"> + <title>The /org/freedesktop/UDisks2/block_devices/* objects</title> + <para> + Objects with an object path starting with + <literal>/org/freedesktop/UDisks2/block_devices/</literal> + implement the + <link linkend="gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</link> + D-Bus interface and may optionally implement other D-Bus interfaces such as + <link linkend="gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</link>, + <link linkend="gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</link> or + <link linkend="gdbus-interface-org-freedesktop-UDisks2-Loop.top_of_page">org.freedesktop.UDisks2.Loop</link> depending on the block device in question. + </para> + <para> + Note that interfaces may be added and removed at run-time. For example, if a block device is full of zeroes, it will not intially implement the + <link linkend="gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</link> + interface; however, if a filesystem is written to disk (using, say, the + <citerefentry> + <refentrytitle>mkfs</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + command) and the filesystem is recognized by the OS (specifically, recognized by + <citerefentry> + <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum> + </citerefentry> and its device probers), the object will gain the interface. If the device is later zeroed or formatted for use as e.g. swap-space, it will lose the + <link linkend="gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</link> + interface. + </para> + </sect1> <sect1 id="udisks-std-options"> <title>The <parameter>options</parameter> parameter</title> <para> |