LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
	Jani Nikula <jani.nikula@linux.intel.com>,
	Markus Heiser <markus.heiser@darmarit.de>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Oleksandr Natalenko <oleksandr@redhat.com>,
	Jonathan Corbet <corbet@lwn.net>, George Spelvin <lkml@sdf.org>
Subject: [PATCH 4/8] lib/list_sort: fix kerneldoc build error
Date: Wed, 22 May 2019 14:50:30 -0600	[thread overview]
Message-ID: <20190522205034.25724-5-corbet@lwn.net> (raw)
In-Reply-To: <20190522205034.25724-1-corbet@lwn.net>

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 <lkml@sdf.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 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 06e900c5587b..712ed1f4eb64 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)
-- 
2.21.0


  parent reply	other threads:[~2019-05-22 20:51 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-22 20:50 [PATCH 0/8] docs: Fixes for recent versions of Sphinx Jonathan Corbet
2019-05-22 20:50 ` [PATCH 1/8] doc: Cope with Sphinx logging deprecations Jonathan Corbet
2019-05-22 20:50 ` [PATCH 2/8] doc: Cope with the deprecation of AutoReporter Jonathan Corbet
2019-05-22 20:50 ` [PATCH 3/8] docs: fix numaperf.rst and add it to the doc tree Jonathan Corbet
2019-05-23  5:45   ` Mike Rapoport
2019-05-22 20:50 ` Jonathan Corbet [this message]
2019-05-22 20:50 ` [PATCH 5/8] docs: fix multiple doc build warnings in enumeration.rst Jonathan Corbet
2019-05-22 20:50 ` [PATCH 6/8] docs/gpu: fix a documentation build break in i915.rst Jonathan Corbet
2019-05-29  6:54   ` Daniel Vetter
2019-05-29 13:50     ` Jonathan Corbet
2019-05-22 20:50 ` [PATCH 7/8] docs: Fix conf.py for Sphinx 2.0 Jonathan Corbet
2019-05-22 20:50 ` [PATCH 8/8] scripts/sphinx-pre-install: make it handle Sphinx versions Jonathan Corbet
2019-05-22 21:22   ` Mauro Carvalho Chehab
2019-05-22 21:44     ` Mauro Carvalho Chehab
2019-05-23  9:39 ` [PATCH 0/8] docs: Fixes for recent versions of Sphinx Oleksandr Natalenko
2019-05-23 10:13   ` Jani Nikula
2019-05-23 10:15     ` Oleksandr Natalenko
2019-05-23 10:38       ` Mauro Carvalho Chehab
2019-05-23 13:48         ` Jonathan Corbet
2019-05-23 10:45   ` Mauro Carvalho Chehab
2019-05-23 11:22     ` Oleksandr Natalenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190522205034.25724-5-corbet@lwn.net \
    --to=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lkml@sdf.org \
    --cc=markus.heiser@darmarit.de \
    --cc=mchehab@kernel.org \
    --cc=oleksandr@redhat.com \
    --subject='Re: [PATCH 4/8] lib/list_sort: fix kerneldoc build error' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).