From patchwork Tue Oct 13 11:54:15 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11835537 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 10BA3697 for ; Tue, 13 Oct 2020 11:57:51 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id E4E9920870 for ; Tue, 13 Oct 2020 11:57:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590271; bh=L0MoMDTN62qRhpslEEZOFn0QRHyIMGhLOJw+1iFPJ6I=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=A/WeH1dw1OEfdruRrAxm/sL0Oc6sss6i0Be1F/M6iixauuKJ5GG4h8/xx4ZYYHZZI P6EwzTR7msqc6VCSpQlGSWYAGhPJLgqttXxyWpTFYkQ+4bQEhEewUqer5H0VOAKOCg zrWOheOv7pYrxGcFmNJb02Wl1RLMQk5lJrbBFxhs= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727900AbgJML5t (ORCPT ); Tue, 13 Oct 2020 07:57:49 -0400 Received: from mail.kernel.org ([198.145.29.99]:57642 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727634AbgJMLyr (ORCPT ); Tue, 13 Oct 2020 07:54:47 -0400 Received: from mail.kernel.org (ip5f5ad5b2.dynamic.kabel-deutschland.de [95.90.213.178]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 508B02250F; Tue, 13 Oct 2020 11:54:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590081; bh=L0MoMDTN62qRhpslEEZOFn0QRHyIMGhLOJw+1iFPJ6I=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=kgsYgqGIm1fbuEqoShM4CkmBLbcRIPXpsJY90QAEPgyfe2DBVut/FiQXsiSBILyig jlO0Zno4C9COsE5QobThFdLO3ZABaQba5TypOb5q2BLfoC4Bukma6xRaVpsmSGGeoq aaMGTJHTFlXr1ohANdhP61OGUmTW5g18TDFtw8ZI= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kSIt5-006CW1-Da; Tue, 13 Oct 2020 13:54:39 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Jens Axboe , linux-block@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v6 60/80] block: bio: fix a warning at the kernel-doc markups Date: Tue, 13 Oct 2020 13:54:15 +0200 Message-Id: <6335319667220b747c06494f3a229598c51b24e7.1602589096.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-block@vger.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 --- block/bio.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/block/bio.c b/block/bio.c index e865ea55b9f9..cee87a9ff799 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 From patchwork Tue Oct 13 11:54:17 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11835521 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 4FB96697 for ; Tue, 13 Oct 2020 11:56:42 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 2747220870 for ; Tue, 13 Oct 2020 11:56:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590202; bh=vURsakoJx7789kBICOX+8pUBm2V03RF9X0CGqrvM0qA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=vn5N4IjCVHxhUmdB15Z1/VkzK8JdhK8Q7ZBACK+0gMi9Hg9RggihqbDpoR4M9CofC /548GptlSFeGCc6/1xG/I5bopjzPUv9RN2eIfWbBrsRQcoYC1m3k2tUz7FIFphYqcQ 4Kh7U1OOz09YR2PLtjTavO39qqe3KssCclOjYjsM= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728028AbgJML4b (ORCPT ); Tue, 13 Oct 2020 07:56:31 -0400 Received: from mail.kernel.org ([198.145.29.99]:57902 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727670AbgJMLyt (ORCPT ); Tue, 13 Oct 2020 07:54:49 -0400 Received: from mail.kernel.org (ip5f5ad5b2.dynamic.kabel-deutschland.de [95.90.213.178]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 5C62622518; Tue, 13 Oct 2020 11:54:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590081; bh=vURsakoJx7789kBICOX+8pUBm2V03RF9X0CGqrvM0qA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=h2N+EjEfvBlBo3nSVPWwyNWr13FPak60CE6NtFsdRAaPEz0rN0ICQtS05oom+eKjV SQ57FyeFUJO0OLamoOialkxd/bBNXVG5NveQs2CO0Uz7kjJ9/KGsLI7zicxYHDLr5Z uqxqYIp5F6ard5j/xMHvQjqlR2VI23F7LHa/sC6I= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kSIt5-006CW5-F7; Tue, 13 Oct 2020 13:54:39 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Jens Axboe , linux-block@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v6 62/80] docs: bio: fix a kerneldoc markup Date: Tue, 13 Oct 2020 13:54:17 +0200 Message-Id: <59415c83f2bc8a9f53cfb906017e0c3a8b5e9bf4.1602589096.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-block@vger.kernel.org Fix this warning: ./block/bio.c:1098: WARNING: Inline emphasis start-string without end-string. The thing is that *iter is not a valid markup. That seems to be a typo: *iter -> @iter Signed-off-by: Mauro Carvalho Chehab --- block/bio.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/block/bio.c b/block/bio.c index cee87a9ff799..8dcb508b651c 100644 --- a/block/bio.c +++ b/block/bio.c @@ -1095,7 +1095,7 @@ static int __bio_iov_append_get_pages(struct bio *bio, struct iov_iter *iter) * released. * * The function tries, but does not guarantee, to pin as many pages as - * fit into the bio, or are requested in *iter, whatever is smaller. If + * fit into the bio, or are requested in @iter, whatever is smaller. If * MM encounters an error pinning the requested pages, it stops. Error * is returned only if 0 pages could be pinned. */