From 8442b8613d878e9c64b39c52dbe5ec59cb2a2962 Mon Sep 17 00:00:00 2001 From: Daniel Mack Date: Wed, 28 Jan 2015 12:34:06 +0100 Subject: doc: turn some into Signed-off-by: Daniel Mack --- doc/kdbus.item.xml | 92 +++++++++++++++++++++++++++--------------------------- 1 file changed, 46 insertions(+), 46 deletions(-) (limited to 'doc/kdbus.item.xml') diff --git a/doc/kdbus.item.xml b/doc/kdbus.item.xml index 9faece22aa8..917bf369a0f 100644 --- a/doc/kdbus.item.xml +++ b/doc/kdbus.item.xml @@ -150,19 +150,19 @@ struct kdbus_item { Command specific items - KDBUS_ITEM_PAYLOAD_VEC - KDBUS_ITEM_PAYLOAD_OFF + KDBUS_ITEM_PAYLOAD_VEC + KDBUS_ITEM_PAYLOAD_OFF Messages are directly copied by the sending process into the receiver's 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 + the data anywhere else. KDBUS_ITEM_PAYLOAD_VEC is used when sending message. The item references a memory address when the payload data can be found. - KDBUS_ITEM_PAYLOAD_OFF is used when messages - are received, and the offset + KDBUS_ITEM_PAYLOAD_OFF is used when messages + are received, and the offset value describes the offset inside the receiving connection's kdbus.pool7 where the message payload can be found. @@ -183,7 +183,7 @@ struct kdbus_vec { - KDBUS_ITEM_PAYLOAD_MEMFD + KDBUS_ITEM_PAYLOAD_MEMFD Transports a file descriptor of a memfd in struct kdbus_memfd in @@ -206,10 +206,10 @@ struct kdbus_memfd { - KDBUS_ITEM_FDS + KDBUS_ITEM_FDS Contains an array of file descriptors. - When used with KDBUS_CMD_SEND, userspace sets + When used with KDBUS_CMD_SEND, userspace sets the values of this array with valid file descriptor numbers. When received as item attached to a message, the array will contain the numbers of the installed file descriptors, or @@ -228,10 +228,10 @@ struct kdbus_memfd { Items specific to some commands - KDBUS_ITEM_CANCEL_FD + KDBUS_ITEM_CANCEL_FD Transports a file descriptor that can be used to cancel a - synchronous KDBUS_CMD_SEND operation by + synchronous KDBUS_CMD_SEND operation by writing to it. The file descriptor is stored in item.fd[0]. The item may only contain one filedescriptor. See @@ -241,7 +241,7 @@ struct kdbus_memfd { - KDBUS_ITEM_BLOOM_PARAMETER + KDBUS_ITEM_BLOOM_PARAMETER TODO struct kdbus_bloom_parameter { @@ -253,7 +253,7 @@ struct kdbus_bloom_parameter { - KDBUS_ITEM_BLOOM_FILTER + KDBUS_ITEM_BLOOM_FILTER TODO struct kdbus_bloom_filter { @@ -265,32 +265,32 @@ struct kdbus_bloom_filter { - KDBUS_ITEM_BLOOM_MASK + KDBUS_ITEM_BLOOM_MASK TODO - KDBUS_ITEM_DST_NAME + KDBUS_ITEM_DST_NAME Contains a well-known name to send a message to, as null-terminated string in item.str. This item is used with - KDBUS_CMD_SEND. See + KDBUS_CMD_SEND. See kdbus.message7 for more information on how to send a message. - KDBUS_ITEM_MAKE_NAME + KDBUS_ITEM_MAKE_NAME TODO - KDBUS_ITEM_ATTACH_FLAGS_SEND - KDBUS_ITEM_ATTACH_FLAGS_RECV + KDBUS_ITEM_ATTACH_FLAGS_SEND + KDBUS_ITEM_ATTACH_FLAGS_RECV Contains a set of attach flags at send or receive time. See @@ -302,7 +302,7 @@ struct kdbus_bloom_filter { - KDBUS_ITEM_ID + KDBUS_ITEM_ID Transports a connection's numerical ID of a connection as u64 value in @@ -311,7 +311,7 @@ struct kdbus_bloom_filter { - KDBUS_ITEM_NAME + KDBUS_ITEM_NAME Transports a name associated with the name registry as null-terminated string as @@ -336,7 +336,7 @@ struct kdbus_name { - KDBUS_ITEM_TIMESTAMP + KDBUS_ITEM_TIMESTAMP Contains both the monotonic and the realtime timestamp, taken when the message @@ -354,7 +354,7 @@ struct kdbus_timestamp { - KDBUS_ITEM_CREDS + KDBUS_ITEM_CREDS Contains credentials such as the user and group in the usual four flavors: @@ -377,7 +377,7 @@ struct kdbus_creds { - KDBUS_ITEM_PIDS + KDBUS_ITEM_PIDS Contains the PID, TID and parent PID (PPID) of a remote peer. @@ -394,7 +394,7 @@ struct kdbus_pids { - KDBUS_ITEM_AUXGROUPS + KDBUS_ITEM_AUXGROUPS Contains the auxiliary (supplementary) groups a remote peer is a member of, stored as array of @@ -406,7 +406,7 @@ struct kdbus_pids { - KDBUS_ITEM_OWNED_NAME + KDBUS_ITEM_OWNED_NAME Contains a well-known name currently owned by a connection. The name is stored as null-terminated string in @@ -416,7 +416,7 @@ struct kdbus_pids { - KDBUS_ITEM_TID_COMM [*] + KDBUS_ITEM_TID_COMM [*] Contains the comm of a task's TID, stored as null-terminated string in @@ -428,7 +428,7 @@ struct kdbus_pids { - KDBUS_ITEM_PID_COMM [*] + KDBUS_ITEM_PID_COMM [*] Contains the comm of a task's PID, stored as null-terminated string in @@ -440,7 +440,7 @@ struct kdbus_pids { - KDBUS_ITEM_EXE [*] + KDBUS_ITEM_EXE [*] Contains the path to the executable of a task, stored as null-terminated string in @@ -452,7 +452,7 @@ struct kdbus_pids { - KDBUS_ITEM_CMDLINE [*] + KDBUS_ITEM_CMDLINE [*] Contains the command line arguments of a task, stored as an array of null-terminated @@ -464,7 +464,7 @@ struct kdbus_pids { - KDBUS_ITEM_CGROUP + KDBUS_ITEM_CGROUP Contains the cgroup path of a task, stored as null-terminated string in item.str. Its @@ -473,7 +473,7 @@ struct kdbus_pids { - KDBUS_ITEM_CAPS + KDBUS_ITEM_CAPS Contains sets of capabilities, stored as struct kdbus_caps in @@ -492,7 +492,7 @@ struct kdbus_caps { - KDBUS_ITEM_SECLABEL + KDBUS_ITEM_SECLABEL Contains the LSM label of a task, stored as null-terminated string in item.str. Its length @@ -501,7 +501,7 @@ struct kdbus_caps { - KDBUS_ITEM_AUDIT + KDBUS_ITEM_AUDIT Contains the audit sessionid and loginuid of a task, stored as @@ -517,7 +517,7 @@ struct kdbus_audit { - KDBUS_ITEM_CONN_DESCRIPTION + KDBUS_ITEM_CONN_DESCRIPTION Contains the connection description, as set by KDBUS_CMD_HELLO or @@ -537,10 +537,10 @@ struct kdbus_audit { [*] 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 + 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 @@ -555,7 +555,7 @@ struct kdbus_audit { - KDBUS_ITEM_POLICY_ACCESS + KDBUS_ITEM_POLICY_ACCESS This item describes a policy access entry to access the policy database of a @@ -575,9 +575,9 @@ struct kdbus_policy_access { - KDBUS_ITEM_NAME_ADD - KDBUS_ITEM_NAME_REMOVE - KDBUS_ITEM_NAME_CHANGE + KDBUS_ITEM_NAME_ADD + KDBUS_ITEM_NAME_REMOVE + KDBUS_ITEM_NAME_CHANGE TODO struct kdbus_notify_name_change { @@ -590,8 +590,8 @@ struct kdbus_notify_name_change { - KDBUS_ITEM_ID_ADD - KDBUS_ITEM_ID_REMOVE + KDBUS_ITEM_ID_ADD + KDBUS_ITEM_ID_REMOVE TODO struct kdbus_notify_id_change { @@ -603,13 +603,13 @@ struct kdbus_notify_id_change { - KDBUS_ITEM_REPLY_TIMEOUT + KDBUS_ITEM_REPLY_TIMEOUT TODO - KDBUS_ITEM_REPLY_DEAD + KDBUS_ITEM_REPLY_DEAD TODO -- cgit v1.2.3