From patchwork Wed Dec 20 22:13:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ryusuke Konishi X-Patchwork-Id: 181794 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp41318dyi; Wed, 20 Dec 2023 14:14:46 -0800 (PST) X-Google-Smtp-Source: AGHT+IHhV/OegPE5/TZeI+N97hVG5fccSzhsQGINPyuQqWlBHwRB0cbRr5Um7kI31vQRiQoS5Ftg X-Received: by 2002:ac8:5bd4:0:b0:427:75d9:e64a with SMTP id b20-20020ac85bd4000000b0042775d9e64amr5506046qtb.124.1703110486340; Wed, 20 Dec 2023 14:14:46 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703110486; cv=none; d=google.com; s=arc-20160816; b=WJGHDKd/bbztI0wrUTZFlLB6LRSs2TzhKZSNXzVpy3lriluPBG+VQZVbHKStl2IgY8 4Zxn/KibvlYtehQ6IZ4ROG25yxD7jleGpAW42btYGh/UfszkfnJb7dKVgu80F6+rIHFY 4xZRl9lWkknGNg7rPi2uVCwik/DbURuzyI/dBCvBSbr/S4a7Nx3GgB7GAcA6X4n0c7zz DDrMNsoL0hre7iAeNEdEyvnjxcWyAW04+RK0RWa5MPq3t1ysw2IlsUmMO3qGEfD/TKkc lQNgkfq59N1SGJVI5tESuCFNPKkXVeYcmk9C0JHNKb/c8Qbvo8igRVSOQre3wYkOgsh8 zp+A== 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=kk68MJUdWFrLkN8+ARexO/EfWP5dvoGb3D27iCAOWr8=; fh=AsbAlzAhlJONv3g3ySeQKgKU7obSPsVD34I7faZBvlQ=; b=NptGsSAGemp9NDECoQGKO/DelRoMUrlvQBYH2XY84eYbl9xiSgd3W4u+Nqw4W7dGU3 2Wih+Z/Q94M+EcYeL3zCXUpCbDmSBaHGGx4mKYmcaJQQeTwbOJ89WFn+adw0huSe5I97 uaf2bBr6Vru1NJIGwW+b8JQRMicdiD+YizPj+eIy3JS5ftp9mQF/rQ1pBizzRA/WJeLl SIgnArXwDCQMq4qBu4VfwjGuqh08rMqF7QBG3Q6dqI7vuGUyG+eVye3clxYtw2eBZb37 uAXDw5jy/mIRzuSDMAOa+DhBhPZ65csgtT2gU0L3PsCJNb4fCSGm0y9fLcfZfhqrka/U gNGA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=kFCGVhh1; spf=pass (google.com: domain of linux-kernel+bounces-7496-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-7496-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id x18-20020a05622a001200b0042561ddacc0si700145qtw.532.2023.12.20.14.14.46 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Dec 2023 14:14:46 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-7496-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=@gmail.com header.s=20230601 header.b=kFCGVhh1; spf=pass (google.com: domain of linux-kernel+bounces-7496-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-7496-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com 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 AFCEB1C2277E for ; Wed, 20 Dec 2023 22:14:39 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 199D34A9B9; Wed, 20 Dec 2023 22:14:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="kFCGVhh1" X-Original-To: linux-kernel@vger.kernel.org Received: from mail-oi1-f170.google.com (mail-oi1-f170.google.com [209.85.167.170]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 131234A985; Wed, 20 Dec 2023 22:14:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-oi1-f170.google.com with SMTP id 5614622812f47-3ba46a19689so82131b6e.3; Wed, 20 Dec 2023 14:14:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1703110449; x=1703715249; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=kk68MJUdWFrLkN8+ARexO/EfWP5dvoGb3D27iCAOWr8=; b=kFCGVhh101rDXnLajuUiaoGETy7pNmHKopbeIIFjJXmSpPMPR+HDsUO9KZabjDga/R dVlmPOS1oTJg9ZMaeDV/RbZ05bBGXrU8FK0TyJNWYxOLkyCPbgh9Xxl/2dNCUw0jS5Cq Jha9CTLLVTgAVXRNlKUxYpFTCC2epK22s0itCmmv2jwjzNyl8eHajzO6DLc0jx/1Ri0/ lglLThYIvnCDxed74A8U1V1+JxG7PTpK4FWT8XM+sR2GFw7TYmTbmX4e9XBkElohdua1 MCaa6aEi/TeZaunjTQqF2p3kJLzhaI/i1hSySXk3dFXDEV8MLfX/l69DGwyUhuOLCzgG 8KWA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1703110449; x=1703715249; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=kk68MJUdWFrLkN8+ARexO/EfWP5dvoGb3D27iCAOWr8=; b=RpPkqMKyYJsHnZXhHi7CrrFUTTl2E5R3EhLoq7uuijYKu1/a6bLXoX8974CebfkyU3 EEpYh/LFhsH7wsRHLa9xxDRcK4ySDa/S3PkoUB57TTFIWLfEVaVk8sZiuqTninTpz3Ge 2HlWgjxbiHe1+8Uc8hct6kqgaA+JCKb8agMPlIS2PXOlf7p2fhLydAaLzFzp+Zt+aQNb lLFGZfvdmHDCgCB7gtyKQwGGeYbozH+Td/+t6RD23vWMffm3sOqfD7OQwlqLrK5mdOz4 o9gwuMXBLtY7RA0ZBIDKXbeXsMHiuVyNUb8wA2L/oUCo//54DVGjgyfsNhfgfBcUsTQu hSoA== X-Gm-Message-State: AOJu0Yxf66PpgiLs/FLKWo7Q38PM6/xa8UP3J890H/PgOcytJDRQo8ow pUDhk1pRtNPcLxL1udRKelA= X-Received: by 2002:aca:2205:0:b0:3b9:e859:53b9 with SMTP id b5-20020aca2205000000b003b9e85953b9mr20912473oic.118.1703110448893; Wed, 20 Dec 2023 14:14:08 -0800 (PST) Received: from carrot.. (i118-19-12-122.s42.a014.ap.plala.or.jp. [118.19.12.122]) by smtp.gmail.com with ESMTPSA id v124-20020a626182000000b006d96d753ca0sm165631pfb.38.2023.12.20.14.14.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Dec 2023 14:14:08 -0800 (PST) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, Randy Dunlap , linux-kernel@vger.kernel.org Subject: [PATCH] nilfs2: cpfile: fix some kernel-doc warnings Date: Thu, 21 Dec 2023 07:13:42 +0900 Message-Id: <20231220221342.11505-1-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 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: 1785840781029304127 X-GMAIL-MSGID: 1785840781029304127 From: Randy Dunlap Correct the function parameter names for nilfs_cpfile_get_info(): cpfile.c:564: warning: Function parameter or member 'cnop' not described in 'nilfs_cpfile_get_cpinfo' cpfile.c:564: warning: Function parameter or member 'mode' not described in 'nilfs_cpfile_get_cpinfo' cpfile.c:564: warning: Function parameter or member 'buf' not described in 'nilfs_cpfile_get_cpinfo' cpfile.c:564: warning: Function parameter or member 'cisz' not described in 'nilfs_cpfile_get_cpinfo' cpfile.c:564: warning: Excess function parameter 'cno' description in 'nilfs_cpfile_get_cpinfo' cpfile.c:564: warning: Excess function parameter 'ci' description in 'nilfs_cpfile_get_cpinfo' Also add missing descriptions of the function's specification. [ konishi.ryusuke@gmail.com: filled in missing descriptions ] Link: https://lkml.kernel.org/r/20231220065931.2372-1-rdunlap@infradead.org Signed-off-by: Randy Dunlap Signed-off-by: Ryusuke Konishi --- Andrew, please add this to the queue for the next merge window. This fixes noticeable kernel-doc warnings for fs/nilfs2/cpfile.c. Thanks, Ryusuke Konishi fs/nilfs2/cpfile.c | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/fs/nilfs2/cpfile.c b/fs/nilfs2/cpfile.c index 9ebefb3acb0e..39136637f715 100644 --- a/fs/nilfs2/cpfile.c +++ b/fs/nilfs2/cpfile.c @@ -552,11 +552,29 @@ static ssize_t nilfs_cpfile_do_get_ssinfo(struct inode *cpfile, __u64 *cnop, } /** - * nilfs_cpfile_get_cpinfo - - * @cpfile: - * @cno: - * @ci: - * @nci: + * nilfs_cpfile_get_cpinfo - get information on checkpoints + * @cpfile: checkpoint file inode + * @cnop: place to pass a starting checkpoint number and receive a + * checkpoint number to continue the search + * @mode: mode of checkpoints that the caller wants to retrieve + * @buf: buffer for storing checkpoints' information + * @cisz: byte size of one checkpoint info item in array + * @nci: number of checkpoint info items to retrieve + * + * nilfs_cpfile_get_cpinfo() searches for checkpoints in @mode state + * starting from the checkpoint number stored in @cnop, and stores + * information about found checkpoints in @buf. + * The buffer pointed to by @buf must be large enough to store information + * for @nci checkpoints. If at least one checkpoint information is + * successfully retrieved, @cnop is updated to point to the checkpoint + * number to continue searching. + * + * Return: Count of checkpoint info items stored in the output buffer on + * success, or the following negative error code on failure. + * * %-EINVAL - Invalid checkpoint mode. + * * %-ENOMEM - Insufficient memory available. + * * %-EIO - I/O error (including metadata corruption). + * * %-ENOENT - Invalid checkpoint number specified. */ ssize_t nilfs_cpfile_get_cpinfo(struct inode *cpfile, __u64 *cnop, int mode,