From patchwork Fri Dec 22 06:19:08 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 182550 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp875893dyi; Thu, 21 Dec 2023 22:19:30 -0800 (PST) X-Google-Smtp-Source: AGHT+IHJCorfuMIuM//FiLSsuH9UXaa2TzdcagVe4vlCHet9H6tYzJPAi8gxXwH4YKRC7O3PqOCw X-Received: by 2002:a05:6214:5019:b0:67f:21af:4437 with SMTP id jo25-20020a056214501900b0067f21af4437mr2274778qvb.55.1703225970329; Thu, 21 Dec 2023 22:19:30 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703225970; cv=none; d=google.com; s=arc-20160816; b=WDlseIBFuYrPVwBkGkSnfThb8fX5PHcelrudDjqdjDcAQtsjymwdq26mW9VIMVovqG gOMKkz3oviUHGxdTXGzcJnB6bES+I6MiYu7hNBQh0harOLK/jtNiWrySW8OcSbGJlk9e xyG+bw5sVBrZ4R0OGYOQ5deUiZKTUTY9pS00z5O5dZQ2KUoH5tZEcJ8yzt1dRuJdTSzq ac+bC4fTyt//qHw87K/kY5XNVn6vL/Nfww1kdU2d8upjLvlHoLHzO8ci/T43IXcQ6c5B 9ITiQvEf6fgBCIsJ5WECC5TZ+wdHIsxDm42AlnLCSmW4h72SNPW7libh5Y36mb/rb/kH HrZg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=H/1i8yuFGfbcX5ybZ7dpr8kd0kCwVEfZQgnUatjDRZI=; fh=SKkXzmOU/fC/HLIA8o8KZMZWF3ChntyXuHCg9cyRQ+k=; b=yopFrCm6PNpf+ULpq2376fg/TL1PjlnWFYrdCXFZcEzCf+ekVgO7bDbMFx/9mmHh4+ CNpLvftpnYbaJKiu242MYbpZZyamko2++1vbnF7lYeJlaoarP+qbIBOtD9uPenblWMLE r7ZU1Ly/mgE87FIXkrs9s2pX3JkSHqvNJhmzzkojc076BcSFUd8mWvsheUnB0H+g3VOT jHuwzFvVt1i/B3E0EDuTbtaWJsVh/r+qMFyqJnOLr01Z3ds3IhTszHqTg6DYWKF0OmZk qqH+KPxNpzr3o08MpXcsLVS1HB8SfTtCs8ryTzMyo3b4NpQAYHLp9nShqwxSdKGljfg1 A/uA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=G0sodgLJ; spf=pass (google.com: domain of linux-kernel+bounces-9394-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9394-ouuuleilei=gmail.com@vger.kernel.org" Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id w10-20020a0cdf8a000000b0067f17eac150si3876937qvl.108.2023.12.21.22.19.30 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Dec 2023 22:19:30 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-9394-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=G0sodgLJ; spf=pass (google.com: domain of linux-kernel+bounces-9394-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9394-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id 24EC21C220BF for ; Fri, 22 Dec 2023 06:19:30 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 9C6DE944B; Fri, 22 Dec 2023 06:19:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="G0sodgLJ" X-Original-To: linux-kernel@vger.kernel.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E2DCE6FC2; Fri, 22 Dec 2023 06:19:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To: Content-ID:Content-Description:In-Reply-To:References; bh=H/1i8yuFGfbcX5ybZ7dpr8kd0kCwVEfZQgnUatjDRZI=; b=G0sodgLJjLbicjRPugj4eCiRke R8ULCFUCOnRiBQ0XzWSu8Yi7tAHPo5iqBuUpmnYz5zTSvru9CDket87q7V5pIGfWtcGzdCq+2/9Z2 5/xYrjR/URe1mC6KY/UAiGBQJK2h0DsUqGx3wvJAiCBCOtAbVFD9HZV6j44n87rOCtUBGlb/KKsWy xuNcYBXTf8nBWu54K9cUec/L0RofketFiNrnHkAhLTo4BtxHARW1SsGu/6k7rYhJNo3xTHSjRbZHN 8Jl58mYONiXMfP+vR22oggIYZSD8qHXoBZUeG3VetknuNU5f+vT7RZIyRYRGHc1ALdpieB98Dg7Cw TXsJZFpg==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rGYsI-0053dC-0D; Fri, 22 Dec 2023 06:19:10 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Philipp Reisner , Lars Ellenberg , =?utf-8?q?Christoph_B=C3=B6hmwa?= =?utf-8?q?lder?= , drbd-dev@lists.linbit.com, Jens Axboe , linux-block@vger.kernel.org Subject: [PATCH] drbd: actlog: fix kernel-doc warnings and spelling Date: Thu, 21 Dec 2023 22:19:08 -0800 Message-ID: <20231222061909.8791-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785961875291666752 X-GMAIL-MSGID: 1785961875291666752 Fix all kernel-doc warnings in drbd_actlog.c: drbd_actlog.c:963: warning: No description found for return value of 'drbd_rs_begin_io' drbd_actlog.c:1015: warning: Function parameter or member 'peer_device' not described in 'drbd_try_rs_begin_io' drbd_actlog.c:1015: warning: Excess function parameter 'device' description in 'drbd_try_rs_begin_io' drbd_actlog.c:1015: warning: No description found for return value of 'drbd_try_rs_begin_io' drbd_actlog.c:1197: warning: No description found for return value of 'drbd_rs_del_all' Fix one spelling error (s/ore/or/). Signed-off-by: Randy Dunlap Cc: Philipp Reisner Cc: Lars Ellenberg Cc: Christoph Böhmwalder Cc: drbd-dev@lists.linbit.com Cc: Jens Axboe Cc: linux-block@vger.kernel.org --- drivers/block/drbd/drbd_actlog.c | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff -- a/drivers/block/drbd/drbd_actlog.c b/drivers/block/drbd/drbd_actlog.c --- a/drivers/block/drbd/drbd_actlog.c +++ b/drivers/block/drbd/drbd_actlog.c @@ -838,8 +838,8 @@ static bool plausible_request_size(int s } /* clear the bit corresponding to the piece of storage in question: - * size byte of data starting from sector. Only clear a bits of the affected - * one ore more _aligned_ BM_BLOCK_SIZE blocks. + * size byte of data starting from sector. Only clear bits of the affected + * one or more _aligned_ BM_BLOCK_SIZE blocks. * * called by worker on C_SYNC_TARGET and receiver on SyncSource. * @@ -957,7 +957,9 @@ static int _is_in_al(struct drbd_device * @device: DRBD device. * @sector: The sector number. * - * This functions sleeps on al_wait. Returns 0 on success, -EINTR if interrupted. + * This functions sleeps on al_wait. + * + * Returns: %0 on success, -EINTR if interrupted. */ int drbd_rs_begin_io(struct drbd_device *device, sector_t sector) { @@ -1004,11 +1006,13 @@ retry: /** * drbd_try_rs_begin_io() - Gets an extent in the resync LRU cache, does not sleep - * @device: DRBD device. + * @peer_device: DRBD device. * @sector: The sector number. * * Gets an extent in the resync LRU cache, sets it to BME_NO_WRITES, then - * tries to set it to BME_LOCKED. Returns 0 upon success, and -EAGAIN + * tries to set it to BME_LOCKED. + * + * Returns: %0 upon success, and -EAGAIN * if there is still application IO going on in this area. */ int drbd_try_rs_begin_io(struct drbd_peer_device *peer_device, sector_t sector) @@ -1190,7 +1194,7 @@ void drbd_rs_cancel_all(struct drbd_devi * drbd_rs_del_all() - Gracefully remove all extents from the resync LRU * @device: DRBD device. * - * Returns 0 upon success, -EAGAIN if at least one reference count was + * Returns: %0 upon success, -EAGAIN if at least one reference count was * not zero. */ int drbd_rs_del_all(struct drbd_device *device)