linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 18/30] block: bio: fix a warning at the kernel-doc markups
Date: Wed,  9 Sep 2020 16:10:49 +0200	[thread overview]
Message-ID: <73fb7b91726f95ba038fbff025bdecdc8faaf204.1599660067.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1599660067.git.mchehab+huawei@kernel.org>

Using "@bio's parent" causes the following waring:
	./block/bio.c:10: WARNING: Inline emphasis start-string without end-string.

The main problem here is that this would be converted into:

	**bio**'s parent

By kernel-doc, which is not a valid notation. It would be
possible to use, instead, this kernel-doc markup:

	``bio's`` parent

Yet, here, is probably simpler to just use an altenative language:

	the parent of @bio

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 block/bio.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/block/bio.c b/block/bio.c
index a9931f23d933..ccd3ab549d41 100644
--- a/block/bio.c
+++ b/block/bio.c
@@ -327,7 +327,7 @@ static void bio_chain_endio(struct bio *bio)
 /**
  * bio_chain - chain bio completions
  * @bio: the target bio
- * @parent: the @bio's parent bio
+ * @parent: the parent bio of @bio
  *
  * The caller won't have a bi_end_io called when @bio completes - instead,
  * @parent's bi_end_io won't be called until both @parent and @bio have
-- 
2.26.2


  parent reply	other threads:[~2020-09-09 17:00 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-09 14:10 [PATCH 00/30] docs: fix documentation build parsing errors Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 01/30] .gitignore: docs: ignore sphinx_*/ directories Mauro Carvalho Chehab
2020-09-10 16:53   ` Jonathan Corbet
2020-09-09 14:10 ` [PATCH 02/30] kernel-doc: include line numbers for function prototypes Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 03/30] dt-bindings: fix references to files converted to yaml Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 04/30] docs: hwmon: adm1266.rst: fix a broken reference Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 05/30] docs: scheduler: fix the directory name on two files Mauro Carvalho Chehab
2020-09-09 18:12   ` Valentin Schneider
2020-09-09 14:10 ` [PATCH 06/30] docs: trace: fix the location of kprobes.rst Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 07/30] MAINTAINERS: fix location of qlogic/LICENSE.qla3xxx Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 08/30] docs: fix location of nommu-mmap.rst file Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 09/30] net: appletalk: Kconfig: Fix docs location Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 10/30] drivers: net: hamradio: fix document location Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 11/30] tools: docs: memory-model: fix references for some files Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 12/30] scripts: device_attr_show.cocci: update location of sysfs doc Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 13/30] docs: SafeSetID: fix a warning Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 14/30] docs: add some new files to their respective index.rst files Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 15/30] docs: powerpc: syscall64-abi.rst: fix a malformed table Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 16/30] docs: watch_queue: fix some warnings Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 17/30] docs: kvm: api.rst: add missing spaces Mauro Carvalho Chehab
2020-09-09 14:10 ` Mauro Carvalho Chehab [this message]
2020-09-09 14:10 ` [PATCH 19/30] docs: soundwire: fix some identation at stream.rst Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 20/30] docs: dma-buf: fix some warnings Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 21/30] iio: industrialio-core.c: solve a kernel-doc warning Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 22/30] kunit: test.h: solve kernel-doc warnings Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 23/30] docs: submitting-patches: use :doc: for references Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 24/30] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 25/30] docs: admin-guide: net.rst: add a missing blank line Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 26/30] iio: iio.h: fix a warning at the kernel-doc markup Mauro Carvalho Chehab
2020-09-11  8:32   ` Jonathan Cameron
2020-09-11 15:40     ` Jonathan Corbet
2020-09-09 14:10 ` [PATCH 27/30] docs: bio: fix a kerneldoc markup Mauro Carvalho Chehab
2020-09-09 14:10 ` [PATCH 28/30] drivers: core: fix kernel-doc markup for dev_err_probe() Mauro Carvalho Chehab
2020-09-09 14:11 ` [PATCH 29/30] kunit: test.h: fix a bad kernel-doc markup Mauro Carvalho Chehab
2020-09-09 14:11 ` [PATCH 30/30] docs: amdgpu: fix a warning when building the documentation Mauro Carvalho Chehab
2020-09-10 16:42 ` [PATCH 00/30] docs: fix documentation build parsing errors Jonathan Corbet
2020-09-11  5:50   ` Mauro Carvalho Chehab

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=73fb7b91726f95ba038fbff025bdecdc8faaf204.1599660067.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
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).