From 33e0e0ea214a78104e4655a696c579860da0f4a0 Mon Sep 17 00:00:00 2001 From: Daniel Mack Date: Tue, 27 Jan 2015 15:20:58 +0100 Subject: [PATCH] doc: cleanup kdbus.bus Signed-off-by: Daniel Mack --- doc/kdbus.bus.xml | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/doc/kdbus.bus.xml b/doc/kdbus.bus.xml index fe2f67e..42a140a 100644 --- a/doc/kdbus.bus.xml +++ b/doc/kdbus.bus.xml @@ -137,24 +137,34 @@ struct kdbus_cmd_make { items - The following items (see kdbus.item7) + The following items (see + kdbus.item7) are expected for KDBUS_CMD_BUS_MAKE. KDBUS_ITEM_MAKE_NAME - Contains a null-terminated string that identifies the bus. The name must be unique across the kdbus domain and must start with the effective UID of the caller followed by a '-'. This item is mandatory. + + Contains a null-terminated string that identifies the + bus. The name must be unique across the kdbus domain and + must start with the effective UID of the caller, followed by + a '-'. This item is mandatory. + KDBUS_ITEM_BLOOM_PARAMETER - Bus-wide bloom parameters passed in a + + Bus-wide bloom parameters passed in a struct kdbus_bloom_parameter. These - settings are copied back to new connections verbatim. This item is mandatory. -TODO: document the bloom_parameter struct and reference that from here (maybe kdbus.bloom.7?) + settings are copied back to new connections verbatim. + This item is mandatory. + See + kdbus.item7 + for a detailed description of this item. @@ -175,9 +185,10 @@ TODO: document the bloom_parameter struct and reference that from here (maybe kd KDBUS_ITEM_ATTACH_FLAGS_SEND - An optional item that contains a set of attach flags that are - returned to connections when they query the bus creator metadata. - If not set, no metadata is returned. + + An optional item that contains a set of attach flags that are + returned to connections when they query the bus creator + metadata. If not set, no metadata is returned. @@ -187,7 +198,8 @@ TODO: document the bloom_parameter struct and reference that from here (maybe kd - Unrecognized items are rejected, and the ioctl will fail with -EINVAL. + Unrecognized items are rejected, and the ioctl will fail with + -EINVAL. -- 2.34.1