From 01c13e48115fa85046218c1a48b3713d857b0eeb Mon Sep 17 00:00:00 2001 From: Tom Gundersen Date: Tue, 27 Jan 2015 00:59:41 +0100 Subject: [PATCH] doc: minor fixes and new TODOs Signed-off-by: Tom Gundersen --- doc/kdbus.bus.xml | 16 ++++++++++++---- doc/kdbus.names.xml | 1 - doc/kdbus.xml | 9 ++++----- 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/doc/kdbus.bus.xml b/doc/kdbus.bus.xml index d7e14e3..fe2f67e 100644 --- a/doc/kdbus.bus.xml +++ b/doc/kdbus.bus.xml @@ -137,14 +137,14 @@ struct kdbus_cmd_make { items - The following items are expected for - KDBUS_CMD_BUS_MAKE. + The following items (see kdbus.item7) + are expected for KDBUS_CMD_BUS_MAKE. KDBUS_ITEM_MAKE_NAME - Contains a string to identify the bus 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. @@ -153,7 +153,8 @@ struct kdbus_cmd_make { Bus-wide bloom parameters passed in a struct kdbus_bloom_parameter. These - settings are copied back to new connections verbatim. + 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?) @@ -201,6 +202,13 @@ struct kdbus_cmd_make { + + -EBADMSG + + A mandatory item is missing. + + + -EINVAL diff --git a/doc/kdbus.names.xml b/doc/kdbus.names.xml index b259472..f2c4c63 100644 --- a/doc/kdbus.names.xml +++ b/doc/kdbus.names.xml @@ -205,7 +205,6 @@ struct kdbus_cmd_name { __u64 kernel_flags; Valid flags for this command, returned by the kernel upon each call. - See section 3.2 for more details. __u64 return_flags; Flags returned by the kernel. Currently unused and always set to zero by diff --git a/doc/kdbus.xml b/doc/kdbus.xml index cdbb7d4..245eca1 100644 --- a/doc/kdbus.xml +++ b/doc/kdbus.xml @@ -79,7 +79,7 @@ A bus is a named object inside a domain. Clients exchange messages over a bus. Multiple buses themselves have no connection to each other; messages can only be exchanged on the same bus. The default endpoint of - a bus, to which clients establish connections to, is the "bus" file + a bus, to which clients establish connections, is the "bus" file /sys/fs/kdbus/<bus name>/bus. Common operating system setups create one "system bus" per system, and one "user bus" for every logged-in user. Applications or services @@ -131,7 +131,6 @@ used to receive messages and answers to ioctl commands from the kernel. It is never used to send anything to the kernel. In order to access that memory, a userspace application must mmap() it into its address space. - See section 12 for more details. See kdbus.pool7 for more details. @@ -166,7 +165,7 @@ connection. Metadata contains information like: system timestamps, UID, GID, TID, proc-starttime, well-known names, process comm, process exe, process argv, cgroup, capabilities, seclabel, audit session, loginuid and the - connection's human-readable name. See section 7 and 13 for more details. + connection's human-readable name. See kdbus.message7 for more details. @@ -178,7 +177,7 @@ The API of kdbus implements the notion of items, submitted through and returned by most ioctls, and stored inside data structures in the - connection's pool. See section 4 for more details. + connection's pool. See kdbus.item7 for more details. @@ -208,7 +207,7 @@ A policy is a set of rules that define which connections can see, talk to, or register a well-known name on the bus. A policy is attached to buses and custom endpoints, and modified by policy holder connections or owners of - custom endpoints. See section 11 for more details. + custom endpoints. See kdbus.policy7 for more details. -- 2.34.1