From: Daniel Mack Date: Tue, 27 Jan 2015 14:03:15 +0000 (+0100) Subject: docs: assorted cleanups X-Git-Tag: upstream/0.20150129.081441utc~15 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2e9d5d5a063bed4791c9b27aecb221218357582f;p=platform%2Fcore%2Fsystem%2Fkdbus-bus.git docs: assorted cleanups Signed-off-by: Daniel Mack --- diff --git a/doc/kdbus.item.xml b/doc/kdbus.item.xml index 08ce31c..9faece2 100644 --- a/doc/kdbus.item.xml +++ b/doc/kdbus.item.xml @@ -155,7 +155,7 @@ struct kdbus_item { Messages are directly copied by the sending process into the receiver's - kdbus.pool2. + kdbus.pool7. This way, two peers can exchange data by effectively doing a single-copy from one process to another; the kernel will not buffer the data anywhere else. KDBUS_ITEM_PAYLOAD_VEC @@ -164,10 +164,10 @@ struct kdbus_item { KDBUS_ITEM_PAYLOAD_OFF is used when messages are received, and the offset value describes the offset inside the receiving connection's - kdbus.pool2 + kdbus.pool7 where the message payload can be found. See - kdbus.message2 + kdbus.message7 for more information on passing of payload data along with a message. @@ -191,7 +191,7 @@ struct kdbus_vec { has to match the actual size of the memfd that was specified when it was created. The start parameter denotes the offset inside the memfd at which the referenced payload starts. See - kdbus.message2 + kdbus.message7 for more information on passing of payload data along with a message. @@ -217,7 +217,7 @@ struct kdbus_memfd { filedescriptor. In either case, the number of entries in the array is derived from the item's total size. See - kdbus.message2 + kdbus.message7 for more information. @@ -235,7 +235,7 @@ struct kdbus_memfd { writing to it. The file descriptor is stored in item.fd[0]. The item may only contain one filedescriptor. See - kdbus.message2 + kdbus.message7 for more information on this item and how to use it. @@ -277,7 +277,7 @@ struct kdbus_bloom_filter { message to, as null-terminated string in item.str. This item is used with KDBUS_CMD_SEND. See - kdbus.message2 + kdbus.message7 for more information on how to send a message. @@ -294,9 +294,9 @@ struct kdbus_bloom_filter { Contains a set of attach flags at send or receive time. See - kdbus2, - kdbus.bus2 and - kdbus.connection2 + kdbus7, + kdbus.bus7 and + kdbus.connection7 for more information on attach flags. @@ -318,7 +318,7 @@ struct kdbus_bloom_filter { struct kdbus_name in item.name. The flags contains the flags of the name. See - kdbus.name2 + kdbus.name7 for more information on how to access the name registry of a bus. struct kdbus_name { @@ -529,8 +529,19 @@ struct kdbus_audit { - [*] Note that the content stored in these metadata items can easily - be tampered by the sending tasks. Therefore, they should + All metadata is automatically translated into the + namespaces of the task that receives them. See + kdbus.message7 + for more information. + + + + [*] Note that the content stored in metadata items of type + KDBUS_ITEM_TID_COMM, + KDBUS_ITEM_PID_COMM, + KDBUS_ITEM_EXE and + KDBUS_ITEM_CMDLINE + can easily be tampered by the sending tasks. Therefore, they should not be used for any sort of security relevant assumptions. The only reason they are transmitted is to let receivers know about details that were set when metadata was @@ -548,10 +559,10 @@ struct kdbus_audit { This item describes a policy access entry to access the policy database of a - kdbus.bus2 or - kdbus.endpoint2. + kdbus.bus7 or + kdbus.endpoint7. Please refer to - kdbus.policy2 + kdbus.policy7 for more information on the policy database and how to access it. struct kdbus_policy_access { diff --git a/doc/kdbus.message.xml b/doc/kdbus.message.xml index ec58fd7..4e75915 100644 --- a/doc/kdbus.message.xml +++ b/doc/kdbus.message.xml @@ -350,7 +350,10 @@ struct kdbus_msg { The message will be augmented by the requested metadata items when - queued into the receiver's pool. See TODO! + queued into the receiver's pool. See + kdbus.connection7 and + kdbus.item7 + for more information on metadata. diff --git a/doc/kdbus.xml b/doc/kdbus.xml index 245eca1..d86609e 100644 --- a/doc/kdbus.xml +++ b/doc/kdbus.xml @@ -462,7 +462,7 @@ - Known metadata item types + Attach flags for metadata items To let the kernel know which metadata information to attach as items to the afformentioned commands, it uses a bitmask. In those, the @@ -511,7 +511,7 @@ - KDBUS_ATTACH_TID_COMM [*] + KDBUS_ATTACH_TID_COMM Requests the attachment of an item of type KDBUS_ITEM_TID_COMM. @@ -519,7 +519,7 @@ - KDBUS_ATTACH_PID_COMM [*] + KDBUS_ATTACH_PID_COMM Requests the attachment of an item of type KDBUS_ITEM_PID_COMM. @@ -527,7 +527,7 @@ - KDBUS_ATTACH_EXE [*] + KDBUS_ATTACH_EXE Requests the attachment of an item of type KDBUS_ITEM_EXE. @@ -586,16 +586,8 @@ Please refer to kdbus.item7 - for detailed information about the layout any payload of items. - - - - [*] Note that the content stored in these items can easily be tampered - by the sending tasks. Therefore, they should not - be used for any sort of security relevant assumptions. The only reason - why they are transmitted is to let receivers know about details that - were set when metadata was collected, even though the task they were - collected from is not active any longer when the items are received. + for detailed information about the layout and payload of items and + what metadata should be used to.