[PATCH 16/30] docs: watch_queue: fix some warnings
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: 2020-09-09 16:59:12
Also in:
lkml
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Fix those warnings:
Documentation/watch_queue.rst:108: WARNING: Inline literal start-string without end-string.
Documentation/watch_queue.rst:108: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:108: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:108: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:185: WARNING: Inline literal start-string without end-string.
Documentation/watch_queue.rst:185: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:184: WARNING: Inline emphasis start-string without end-string.
The problem here is that the ``notation`` doesn't accept
multi lines. So, replace it to a code block using:
::
notation
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/watch_queue.rst | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/Documentation/watch_queue.rst b/Documentation/watch_queue.rst
index 3e647992be31..85565e8a15da 100644
--- a/Documentation/watch_queue.rst
+++ b/Documentation/watch_queue.rst@@ -104,8 +104,10 @@ watch that specific key). To manage a watch list, the following functions are provided: - * ``void init_watch_list(struct watch_list *wlist, - void (*release_watch)(struct watch *wlist));`` + * :: + + void init_watch_list(struct watch_list *wlist, + void (*release_watch)(struct watch *wlist)); Initialise a watch list. If ``release_watch`` is not NULL, then this indicates a function that should be called when the watch_list object is
@@ -180,9 +182,11 @@ The following functions are provided to manage watches: driver-settable fields in the watch struct must have been set before this is called. - * ``int remove_watch_from_object(struct watch_list *wlist, - struct watch_queue *wqueue, - u64 id, false);`` + * :: + + int remove_watch_from_object(struct watch_list *wlist, + struct watch_queue *wqueue, + u64 id, false); Remove a watch from a watch list, where the watch must match the specified watch queue (``wqueue``) and object identifier (``id``). A notification
--
2.26.2