Commit 50f32634 authored Sep 09, 2020 by Mauro Carvalho Chehab Committed by Jonathan Corbet Sep 10, 2020

docs: watch_queue: fix some warnings



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>
Link: https://lore.kernel.org/r/42706310c09a6b4588a1a41078207246ad1238fa.1599660067.git.mchehab+huawei@kernel.org


Signed-off-by: Jonathan Corbet <corbet@lwn.net>

parent 4d05e3a0

Documentation/watch_queue.rst

+9 −5

Original line number	Diff line number	Diff line
		@@ -103,8 +103,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
		@@ -179,9 +181,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,
		* ::

		int remove_watch_from_object(struct watch_list *wlist,
		struct watch_queue *wqueue,
		u64 id, false);``
		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

Admin message