lib/list_sort: fix kerneldoc build error [Linux 5.2]

lib/list_sort: fix kerneldoc build error [Linux 5.2]

This Linux kernel change "lib/list_sort: fix kerneldoc build error" is included in the Linux 5.2 release. This change is authored by Jonathan Corbet <corbet [at] lwn.net> on Wed May 22 13:41:45 2019 -0600. The commit for this change in Linux stable tree is f35a1ab (patch).

lib/list_sort: fix kerneldoc build error

Commit 043b3f7b6388 ("lib/list_sort: simplify and remove
MAX_LIST_LENGTH_BITS") added some useful kerneldoc info, but also broke the
docs build:

  ./lib/list_sort.c:128: WARNING: Definition list ends without a blank line; unexpected unindent.
  ./lib/list_sort.c:161: WARNING: Unexpected indentation.
  ./lib/list_sort.c:162: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix the offending literal block and make the error go away.

Fixes: 043b3f7b6388 ("lib/list_sort: simplify and remove MAX_LIST_LENGTH_BITS")
Cc: George Spelvin <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

There are 3 lines of Linux source code added/deleted in this change. Code changes to Linux kernel are as follows.

 lib/list_sort.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/list_sort.c b/lib/list_sort.c
index 06e900c..712ed1f 100644
--- a/lib/list_sort.c
+++ b/lib/list_sort.c
@@ -120,7 +120,8 @@ static void merge_final(void *priv, cmp_func cmp, struct list_head *head,
  * The latter offers a chance to save a few cycles in the comparison
  * (which is used by e.g. plug_ctx_cmp() in block/blk-mq.c).
  *
- * A good way to write a multi-word comparison is
+ * A good way to write a multi-word comparison is::
+ *
  * if (a->high != b->high)
  *     return a->high > b->high;
  * if (a->middle != b->middle)

Leave a Reply

Your email address will not be published. Required fields are marked *