[PATCH 17/35] docs: watch_queue.rst: supress some Sphinx warnings

Mauro Carvalho Chehab
2020-04-08T15:48:08Z

Sphinx doesn't like multi-line literal blocks with ``foobar``:

Documentation/watch_queue.rst:109: WARNING: Inline literal start-string without end-string.
Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:186: WARNING: Inline literal start-string without end-string.
Documentation/watch_queue.rst:186: WARNING: Inline emphasis start-string without end-string.
Documentation/watch_queue.rst:185: WARNING: Inline emphasis start-string without end-string.

So, let's use the "::" markup instead.

While we could do the fix only at the affected lines, let's
do the same change along the entire file, in order to preserve
the same look and feel at the entire doc.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/watch_queue.rst | 34 +++++++++++++++++++++++++---------
1 file changed, 25 insertions(+), 9 deletions(-)

diff --git a/Documentation/watch_queue.rst b/Documentation/watch_queue.rst
index d8f70282d247..f1ffe9cdf81f 100644
--- a/Documentation/watch_queue.rst
+++ b/Documentation/watch_queue.rst
@@ -105,15 +105,19 @@ 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
destroyed to discard any references the watch list holds on the watched
object.

- * ``void remove_watch_list(struct watch_list *wlist);``
+ * ::
+
+ void remove_watch_list(struct watch_list *wlist);

This removes all of the watches subscribed to a watch_list and frees them
and then destroys the watch_list object itself.
@@ -127,14 +131,18 @@ records will be written into. The workings of this are hidden entirely inside
of the watch_queue device driver, but it is necessary to gain a reference to it
to set a watch. These can be managed with:

- * ``struct watch_queue *get_watch_queue(int fd);``
+ * ::
+
+ struct watch_queue *get_watch_queue(int fd);``

Since watch queues are indicated to the kernel by the fd of the pipe that
implements the buffer, userspace must hand that fd through a system call.
This can be used to look up an opaque pointer to the watch queue from the
system call.

- * ``void put_watch_queue(struct watch_queue *wqueue);``
+ * ::
+
+ void put_watch_queue(struct watch_queue *wqueue);

This discards the reference obtained from ``get_watch_queue()``.

@@ -170,18 +178,24 @@ different ID are ignored.

The following functions are provided to manage watches:

- * ``void init_watch(struct watch *watch, struct watch_queue *wqueue);``
+ * ::
+
+ void init_watch(struct watch *watch, struct watch_queue *wqueue);

Initialise a watch object, setting its pointer to the watch queue, using
appropriate barriering to avoid lockdep complaints.

- * ``int add_watch_to_object(struct watch *watch, struct watch_list *wlist);``
+ * ::
+
+ int add_watch_to_object(struct watch *watch, struct watch_list *wlist);

Subscribe a watch to a watch list (notification source). The
driver-settable fields in the watch struct must have been set before this
is called.

- * ``int remove_watch_from_object(struct watch_list *wlist,
+ * ::
+
+ int remove_watch_from_object(struct watch_list *wlist,
struct watch_queue *wqueue,
u64 id, false);``

@@ -190,7 +204,9 @@ The following functions are provided to manage watches:
(``WATCH_META_REMOVAL_NOTIFICATION``) is sent to the watch queue to
indicate that the watch got removed.

- * ``int remove_watch_from_object(struct watch_list *wlist, NULL, 0, true);``
+ * ::
+
+ int remove_watch_from_object(struct watch_list *wlist, NULL, 0, true);

Remove all the watches from a watch list. It is expected that this will be
called preparatory to destruction and that the watch list will be
--
2.25.2