From d7505b882bab7ed0e0657fd0165d24bd3bedc414 Mon Sep 17 00:00:00 2001 From: Greg Kroah-Hartman Date: Sat, 1 Nov 2014 18:29:29 -0700 Subject: kdbus.txt: grammer fixes from Peter Meerwald --- kdbus.txt | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/kdbus.txt b/kdbus.txt index 9c0d143844e..67766f711bd 100644 --- a/kdbus.txt +++ b/kdbus.txt @@ -2,7 +2,7 @@ D-Bus is a system for powerful, easy to use interprocess communication (IPC). The focus of this document is an overview of the low-level, native kernel D-Bus transport called kdbus. Kdbus in the kernel acts similar to a device driver, -all communication between processes take place over special character device +all communication between processes takes place over special character device nodes in /dev/kdbus/. For the general D-Bus protocol specification, the payload format, the @@ -308,9 +308,9 @@ endpoint called 'bus'. The bus owner has the ability to create custom endpoints with specific names, permissions, and policy databases (see below). To create a custom endpoint, use the KDBUS_CMD_ENDPOINT_MAKE ioctl with struct -kdbus_cmd_make. Custom endpoints always have a policy db that, by default, -does not allow anything. Everything that users of this new endpoint should be -able to do has to be explicitly specified through KDBUS_ITEM_NAME and +kdbus_cmd_make. Custom endpoints always have a policy database that, by +default, does not allow anything. Everything that users of this new endpoint +should be able to do has to be explicitly specified through KDBUS_ITEM_NAME and KDBUS_ITEM_POLICY_ACCESS items. 5.3 Creating domains, buses and endpoints @@ -359,7 +359,7 @@ Messages with a specific uint64_t destination id are directly delivered to the connection with the corresponding id. Messages with the special destination id KDBUS_DST_ID_BROADCAST are broadcast messages and are potentially delivered to all known connections on the bus; clients interested in broadcast messages -need to subscribe to the specific messages they are interested though, before +need to subscribe to the specific messages they are interested, though before any broadcast message reaches them. Messages synthesized and sent directly by the kernel will carry the special @@ -497,7 +497,7 @@ struct kdbus_cmd_hello { KDBUS_ITEM_NAME KDBUS_ITEM_POLICY_ACCESS For activators and policy holders only, combinations of these two - items describe policy access entries (see section about policy db). + items describe policy access entries (see section about policy). KDBUS_ITEM_CREDS KDBUS_ITEM_SECLABEL @@ -573,7 +573,7 @@ struct kdbus_cmd_info { All other items are currently ignored. }; -After the ioctl returns, the following struct will be stored in the caller's +After the ioctl returns, the following struct will be stored in the caller's pool at 'offset'. struct kdbus_info { @@ -665,10 +665,9 @@ A connection can be terminated by simply closing the file descriptor that was used to start the connection. All pending incoming messages will be discarded, and the memory in the pool will be freed. -An alternative way of way of closing down a connection is calling the -KDBUS_CMD_BYEBYE ioctl on it, which will only succeed if the message queue -of the connection is empty at the time of closing, otherwise, -EBUSY is -returned. +An alternative way of closing down a connection is calling the KDBUS_CMD_BYEBYE +ioctl on it, which will only succeed if the message queue of the connection is +empty at the time of closing, otherwise, -EBUSY is returned. When this ioctl returns successfully, the connection has been terminated and won't accept any new messages from remote peers. This way, a connection can @@ -688,8 +687,8 @@ message metadata fields, raw data, references to data, or file descriptors. -------------------- Messages are passed to the kernel with the KDBUS_CMD_MSG_SEND ioctl. Depending -on the the destination address of the message, the kernel delivers the message -to the specific destination connection or to all connections on the same bus. +on the destination address of the message, the kernel delivers the message to +the specific destination connection or to all connections on the same bus. Sending messages across buses is not possible. Messages are always queued in the memory pool of the destination connection (see below). @@ -698,7 +697,7 @@ be sent. struct kdbus_msg { __u64 size; - The over all size of the struct, including the attached items. + The overall size of the struct, including the attached items. __u64 flags; Flags for message delivery: @@ -1005,8 +1004,8 @@ struct kdbus_cmd_name { Valid flags for this command, returned by the kernel upon each call. struct kdbus_item items[0]; - Items to submit the name. Currently, one one item of type KDBUS_ITEM_NAME - is expected and allowed, and the contained string must be a valid bus name. + Items to submit the name. Currently, one item of type KDBUS_ITEM_NAME is + expected and allowed, and the contained string must be a valid bus name. }; @@ -1030,8 +1029,8 @@ struct kdbus_cmd_name { __u64 flags; struct kdbus_item items[0]; - Items to submit the name. Currently, one one item of type KDBUS_ITEM_NAME - is expected and allowed, and the contained string must be a valid bus name. + Items to submit the name. Currently, one item of type KDBUS_ITEM_NAME is + expected and allowed, and the contained string must be a valid bus name. }; @@ -1105,7 +1104,7 @@ struct kdbus_name_info { The flags of the owning connection. struct kdbus_item items[0]; - Items containing the actual name. Currently, one one item of type + Items containing the actual name. Currently, one item of type KDBUS_ITEM_NAME will be attached. }; -- cgit v1.2.3