Messages in this thread | | | Date | Thu, 8 Oct 2015 15:46:01 +0200 | Subject | Re: [PATCH 03/44] kdbus: Kernel-docs and comments trivial fixes | From | David Herrmann <> |
| |
Hi
On Thu, Oct 8, 2015 at 1:31 PM, Sergei Zviagintsev <sergei@s15v.net> wrote: > - kdbus_conn_unref(): Fix style issue to stay similar to other > kernel-docs. > > - kdbus_conn_disconnect(): Update the name of parameter: > "ensure_msg_list_empty" -> "ensure_queue_empty". > > - kdbus_conn_entry_insert(): Fix typo: dot -> comma. > > - struct kdbus_conn: Remove lost "activator for" string. > > - kdbus_fs_init(): Fix typo: "nameing" -> "naming". > > - kdbus_node_deactivate(): Fix typo in comment: > "node as children" -> "node has children". > > - kdbus_pool_slice_alloc(): Remove description of kvec and iovec as > they relate to the old code. > > - struct kdbus_queue_entry: Fix typo: "messages" -> "message". > > - kdbus_pool_slice_publish(): Remove obsolete line from the > description. > > Signed-off-by: Sergei Zviagintsev <sergei@s15v.net> > --- > ipc/kdbus/connection.c | 6 +++--- > ipc/kdbus/connection.h | 1 - > ipc/kdbus/fs.c | 2 +- > ipc/kdbus/node.c | 4 ++-- > ipc/kdbus/pool.c | 5 +---- > ipc/kdbus/queue.h | 2 +- > 6 files changed, 8 insertions(+), 12 deletions(-) > > diff --git a/ipc/kdbus/connection.c b/ipc/kdbus/connection.c > index ef63d6533273..4f3cd370ecd9 100644 > --- a/ipc/kdbus/connection.c > +++ b/ipc/kdbus/connection.c > @@ -317,7 +317,7 @@ struct kdbus_conn *kdbus_conn_ref(struct kdbus_conn *conn) > > /** > * kdbus_conn_unref() - drop a connection reference > - * @conn: Connection (may be NULL) > + * @conn: Connection, may be %NULL
We usually use "Foobar, or NULL" in kdbus docs, and then describe the case for NULL in the description.
Otherwise, looks good, thanks! David
> * > * When the last reference is dropped, the connection's internal structure > * is freed. > @@ -490,7 +490,7 @@ exit_disconnect: > * case the connection's message list is not > * empty > * > - * If @ensure_msg_list_empty is true, and the connection has pending messages, > + * If @ensure_queue_empty is true, and the connection has pending messages, > * -EBUSY is returned. > * > * Return: 0 on success, negative errno on failure > @@ -880,7 +880,7 @@ static int kdbus_conn_entry_sync_attach(struct kdbus_conn *conn_dst, > * @reply: The reply tracker to attach to the queue entry > * @name: Destination name this msg is sent to, or NULL > * > - * Return: 0 on success. negative error otherwise. > + * Return: 0 on success, negative error otherwise. > */ > int kdbus_conn_entry_insert(struct kdbus_conn *conn_src, > struct kdbus_conn *conn_dst, > diff --git a/ipc/kdbus/connection.h b/ipc/kdbus/connection.h > index 1ad082014faa..679f393d3e68 100644 > --- a/ipc/kdbus/connection.h > +++ b/ipc/kdbus/connection.h > @@ -53,7 +53,6 @@ struct kdbus_staging; > * @reply_list: List of connections this connection should > * reply to > * @work: Delayed work to handle timeouts > - * activator for > * @match_db: Subscription filter to broadcast messages > * @meta_proc: Process metadata of connection creator, or NULL > * @meta_fake: Faked metadata, or NULL > diff --git a/ipc/kdbus/fs.c b/ipc/kdbus/fs.c > index 09c480924b9e..47e652f2ee0e 100644 > --- a/ipc/kdbus/fs.c > +++ b/ipc/kdbus/fs.c > @@ -383,7 +383,7 @@ static struct file_system_type fs_type = { > * kdbus_fs_init() - register kdbus filesystem > * > * This registers a filesystem with the VFS layer. The filesystem is called > - * `KBUILD_MODNAME "fs"', which usually resolves to `kdbusfs'. The nameing > + * `KBUILD_MODNAME "fs"', which usually resolves to `kdbusfs'. The naming > * scheme allows to set KBUILD_MODNAME to "kdbus2" and you will get an > * independent filesystem for developers. > * > diff --git a/ipc/kdbus/node.c b/ipc/kdbus/node.c > index 89f58bc85433..133fb01a35cc 100644 > --- a/ipc/kdbus/node.c > +++ b/ipc/kdbus/node.c > @@ -557,8 +557,8 @@ void kdbus_node_deactivate(struct kdbus_node *node) > /* > * To avoid recursion, we perform back-tracking while deactivating > * nodes. For each node we enter, we first mark the active-counter as > - * deactivated by adding BIAS. If the node as children, we set the first > - * child as current position and start over. If the node has no > + * deactivated by adding BIAS. If the node has children, we set the > + * first child as current position and start over. If the node has no > * children, we drain the node by waiting for all active refs to be > * dropped and then releasing the node. > * > diff --git a/ipc/kdbus/pool.c b/ipc/kdbus/pool.c > index 63ccd55713c7..0433e26b777e 100644 > --- a/ipc/kdbus/pool.c > +++ b/ipc/kdbus/pool.c > @@ -192,9 +192,7 @@ static struct kdbus_pool_slice *kdbus_pool_find_slice(struct kdbus_pool *pool, > * @accounted: Whether this slice should be accounted for > * > * The returned slice is used for kdbus_pool_slice_release() to > - * free the allocated memory. If either @kvec or @iovec is non-NULL, the data > - * will be copied from kernel or userspace memory into the new slice at > - * offset 0. > + * free the allocated memory. > * > * Return: the allocated slice on success, ERR_PTR on failure. > */ > @@ -411,7 +409,6 @@ void kdbus_pool_publish_empty(struct kdbus_pool *pool, u64 *off, u64 *size) > * This prepares a slice to be published to user-space. > * > * This call combines the following operations: > - * * the memory region is flushed so the user's memory view is consistent > * * the slice is marked as referenced by user-space, so user-space has to > * call KDBUS_CMD_FREE to release it > * * the offset and size of the slice are written to the given output > diff --git a/ipc/kdbus/queue.h b/ipc/kdbus/queue.h > index bf686d182ce1..92f7549d8c9b 100644 > --- a/ipc/kdbus/queue.h > +++ b/ipc/kdbus/queue.h > @@ -38,7 +38,7 @@ struct kdbus_queue { > }; > > /** > - * struct kdbus_queue_entry - messages waiting to be read > + * struct kdbus_queue_entry - message waiting to be read > * @entry: Entry in the connection's list > * @prio_node: Entry in the priority queue tree > * @prio_entry: Queue tree node entry in the list of one priority > -- > 1.8.3.1 >
| |