From nobody Sat Feb 7 08:23:03 2026 Received: from mail-oo1-f47.google.com (mail-oo1-f47.google.com [209.85.161.47]) (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 9624712BF32; Fri, 16 Aug 2024 07:43:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.161.47 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794215; cv=none; b=QUKUSxysIOekmPzamtajbOrBx/rzC9NQulUzdIQjtDjv4lYzN2pRwJb/7GAyU7oLr0Y+PB4uo8UfsCOvwXVTx3No0hQTdDBXkrKhJuAqvBUyrIDfjPESZUdNOCU1/qzCHcOrTfPGFwG+3EtATl5VwR68qgYj3BJmKEVIwoubT+M= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794215; c=relaxed/simple; bh=QkJcD+/7+feE3IKtKVd5MY7QxZ35Ciq4ku4FJsISGwg=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=LH3svkCUW1JzUyGDTw7GHbYx0/2bApbHxDSpXJHp9STn/wFSiO598vbVIA7I4vzHbCo+lydo0rrLaDl4nZ5pinMJ8q54sOdE5kl9cdkh9zhg5GaT2M0ZoWPrGZILatAavFvssOjhnT0Y1OpFtbgh3uRqnNeOKPALQfnqRFAphec= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=jOLfe1Ku; arc=none smtp.client-ip=209.85.161.47 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="jOLfe1Ku" Received: by mail-oo1-f47.google.com with SMTP id 006d021491bc7-5d5bb03fe42so994043eaf.3; Fri, 16 Aug 2024 00:43:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794212; x=1724399012; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=f6eyKXO4gQ7WsuUsRihPfatUBDrlwvh2bJ1+YnjG9XA=; b=jOLfe1Kuu2UKVuJ5W0HIvh3D2rHxWQ3f1buc0IDUkIcMKQDLP80l73HjmPBvkTDe0j NyUCojBueuxJkZOlgqlf6XCFSeDwt8uOSsEPZeQYHmM+V/BP5EIuEhaTkE291yMqqMDw vtDnUxKxKIW0McZAwHnq3ryNXyzjj3dTItJPuEn9OKCIFHV4JHZhXV5HBny9YLhsXx7q Y5N62v6luAPeUBPSwXLzEJbSRkQZ2TvudDEUDIL2D3DYOKOcSvEt6XKkhIKKKP7B4CpH uG1IHGWwLhcXWVs4b1AJnAYCemjW9wEq5yPucR/Ei/gI3SS5R8uzRBJs06e6ajSRks9j FusQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794212; x=1724399012; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=f6eyKXO4gQ7WsuUsRihPfatUBDrlwvh2bJ1+YnjG9XA=; b=Ym2OIVef5N4jMZ9tAMIus9f8yF636WqVlpYxWcc2qY2Pdax9jowMCuCJPQyeob+bBb Vcln2OjMuBp5cliSxmr+t6BNuVIfkDgiwUI1PJcM3ov0Amzu8MzlrT2tbWXdc98fiz1X kNYrv01OC7hli6OxgLGjlvN2XlRHT2ZFrFRjjwa+jhmzf1FoKPX1s6krNa308dfin7Wl mZR//VZ7B6v4Ua0yECLcrtqPYWoZ4i5stcP9jpKViXPsLIjX2BWY6eUa4bccRI1O01eK YuglwoeeZ8+EliZn6NUHIAqYKEXIv159x5M3gLN9sIPMtYDIA8PHu8DOQxVYIQgx+rDr rxBg== X-Forwarded-Encrypted: i=1; AJvYcCVQ9LHDOyAP+Z0FXPlnHVAc/S22nhV+KaK+GUxbOwPa+k/pQWpdjgEf4nfy4RjSBqOTlFd+xZrFu51GRlPreA2T2aHCfbYiZ2Gro+cX X-Gm-Message-State: AOJu0Ywx4kfFedHG1f5OhocsON8tANTQ7J4aB27d6EvLu3iyVS2UmqHl 4msiqzq/nH5HKi6ajrAxqr8P/vOUN4Uld9ck2fq8sJ55seBOf9GCvGpAsg== X-Google-Smtp-Source: AGHT+IHhsZA0iQUnIsJIWt6Xqia6sfSohcfChNNJ0cALOZccgegDiKNxUuL/bSfLoYMbuclcynQPPg== X-Received: by 2002:a05:6870:5687:b0:254:a09c:6ddf with SMTP id 586e51a60fabf-2701c3f7b34mr2314519fac.24.1723794212377; Fri, 16 Aug 2024 00:43:32 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:31 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 1/8] nilfs2: add missing argument description for __nilfs_error() Date: Fri, 16 Aug 2024 16:43:12 +0900 Message-Id: <20240816074319.3253-2-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add missing argument description to __nilfs_error function and remove the following warnings from kernel-doc script output: fs/nilfs2/super.c:121: warning: Function parameter or struct member 'sb' not described in '__nilfs_error' fs/nilfs2/super.c:121: warning: Function parameter or struct member 'function' not described in '__nilfs_error' fs/nilfs2/super.c:121: warning: Function parameter or struct member 'fmt' not described in '__nilfs_error' Signed-off-by: Ryusuke Konishi --- fs/nilfs2/super.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/fs/nilfs2/super.c b/fs/nilfs2/super.c index 76e35e6773d1..8eb8dbc9f51c 100644 --- a/fs/nilfs2/super.c +++ b/fs/nilfs2/super.c @@ -105,6 +105,10 @@ static void nilfs_set_error(struct super_block *sb) =20 /** * __nilfs_error() - report failure condition on a filesystem + * @sb: super block instance + * @function: name of calling function + * @fmt: format string for message to be output + * @...: optional arguments to @fmt * * __nilfs_error() sets an ERROR_FS flag on the superblock as well as * reporting an error message. This function should be called when --=20 2.34.1 From nobody Sat Feb 7 08:23:03 2026 Received: from mail-oi1-f175.google.com (mail-oi1-f175.google.com [209.85.167.175]) (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 72DF812D758; Fri, 16 Aug 2024 07:43:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.175 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794217; cv=none; b=k2GxSZxxJWuIf3dIHXfmkvEXAqTMnRc/yA/LDZw0Jcol69baqXCUr263zDC3bjzMzIm1iIsHCDt9Bcle+QkzVeNmuCbQNgOBmE8nhsh4orF9fRH5nUO4G5rh/FXD737t2pdFEY83Zc2icKeubNrD+ZjKpsLFpnHOCslIkrRGCU0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794217; c=relaxed/simple; bh=0O3wDAmTm2R1VMrqJvvg3nYqYNOHRJm6KgJ2d0woyj0=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=JLamBFa8TrMxpPzTBNBW5STLtIh3+xbhpqwh8VswiEbA+dk17PkRZ7hkC8xmJH4PHXjCnBNZyF70Tix6NqY0FpG47L/9v1eG5yMnU++0p2ribSztzPVpflNT7JCgaezWxm0A2mpm4vMs0XVAyFgVSHa+bsyOTuJw1haSocAKw/0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=Qna0m8lr; arc=none smtp.client-ip=209.85.167.175 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Qna0m8lr" Received: by mail-oi1-f175.google.com with SMTP id 5614622812f47-3db14339fb0so991916b6e.2; Fri, 16 Aug 2024 00:43:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794214; x=1724399014; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Tkr4pPScm9JM4FL7Xb5OEIFIgdaIIjYg1Mhw7IU/3oY=; b=Qna0m8lrDF2ia+AthA0KKRDuyXZCfMBuagZIqtjZq5j/d9d5xm+jc4x/kRBalYdQUt KlK2aNlDpALJ/6Q+Bo/dNmPN9yLHHpBOmFTi7QeKlVuZ5rTOhivU4KdmQh6xHc5v8XZP X8w8m7c1fFMJPPsUDNIQ7SQKTW5Sbe1ymhWx8u1r0yzYL8zZ4VIIr4T9AlN3BZaDoI+L TtyQMfnVTWGp5fV5Skynr6d1HMG3n2h+4Qi/vXEY0Xt8fHTvBsp+Q9fySR+Et6yPa2Sg FjRfk4xUkQPWMyZx8DxvE+1xpNDWHyh0esGhyFL7H5/P087/0RmzJe8QxMjTvFNrhhbp gsLQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794214; x=1724399014; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Tkr4pPScm9JM4FL7Xb5OEIFIgdaIIjYg1Mhw7IU/3oY=; b=j0ArYZs1fa8IWkw1gnw/pRXNfabXVs5unOagOA2wr3wdpfgQkuf509UB+B4Nni2aqT u+nsHPOEAMZcqcuzuXbvoYN0s0gIakD4OJ2o5xvTrO6w6K088KSrfIjW2xn7qRjooDN1 Sx/ANX8z25bO+ZfjDE1pdicXekeZKREmTzXH5uWLAoPJjxsg4s5M2Lrk4K1UUSvEF4c/ IiJ1bCDZkClbDdzDL4zLM5tTuC7A5pPekiyeZYEijs+fE3ckWvTiCwh1AbOV8S/f37kF sJCKL2dXHU2u9iKRMrLU/3OMxAXUit9toVsrCxKPTU1w+7AO1KfcHvjle7Y3x80VfVWT sysg== X-Forwarded-Encrypted: i=1; AJvYcCUinRvSGsJ+1T/H/0WUKpec9zrPQ0OvPCmDpTdRdhzrTYF+GmF6qgGTtyW2nGu8f0mtrKnrnFJqWQ1FKiOo+HukZMXXan8vLX21ZQw8 X-Gm-Message-State: AOJu0Yzc+17fnkBfiXdc1OLeR+kO7Q7IucTL4S4Ygh4sLyL8VjtB1QoB hEhvHq2omY+6TfPQvw88IH01lG/3LdVy7gnNhLsqac4GtnbXoRAiTdf/FQ== X-Google-Smtp-Source: AGHT+IGMu8hARPHej8oEN2vm6zpj/KqMKT81sLaIr6ulqQ1zduObVayQj2yRqUUChAcfsCZIR9in5A== X-Received: by 2002:a05:6808:1513:b0:3d5:5fbe:b2fa with SMTP id 5614622812f47-3dd3ae00e4amr1937514b6e.35.1723794214503; Fri, 16 Aug 2024 00:43:34 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:33 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 2/8] nilfs2: add missing argument descriptions for ioctl-related helpers Date: Fri, 16 Aug 2024 16:43:13 +0900 Message-Id: <20240816074319.3253-3-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add missing argument descriptions and return value information to the kernel-doc comments for ioctl helper functions, and eliminate the following warnings output by the kernel-doc script: fs/nilfs2/ioctl.c:120: warning: Function parameter or struct member 'dentry' not described in 'nilfs_fileattr_get' fs/nilfs2/ioctl.c:120: warning: Function parameter or struct member 'fa' not described in 'nilfs_fileattr_get' fs/nilfs2/ioctl.c:133: warning: Function parameter or struct member 'idmap' not described in 'nilfs_fileattr_set' fs/nilfs2/ioctl.c:133: warning: Function parameter or struct member 'dentry' not described in 'nilfs_fileattr_set' fs/nilfs2/ioctl.c:133: warning: Function parameter or struct member 'fa' not described in 'nilfs_fileattr_set' fs/nilfs2/ioctl.c:164: warning: Function parameter or struct member 'inode' not described in 'nilfs_ioctl_getversion' fs/nilfs2/ioctl.c:164: warning: Function parameter or struct member 'argp' not described in 'nilfs_ioctl_getversion' Signed-off-by: Ryusuke Konishi --- fs/nilfs2/ioctl.c | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/fs/nilfs2/ioctl.c b/fs/nilfs2/ioctl.c index 297989e51ee6..fa77f78df681 100644 --- a/fs/nilfs2/ioctl.c +++ b/fs/nilfs2/ioctl.c @@ -115,7 +115,11 @@ static int nilfs_ioctl_wrap_copy(struct the_nilfs *nil= fs, } =20 /** - * nilfs_fileattr_get - ioctl to support lsattr + * nilfs_fileattr_get - retrieve miscellaneous file attributes + * @dentry: the object to retrieve from + * @fa: fileattr pointer + * + * Return: always 0 as success. */ int nilfs_fileattr_get(struct dentry *dentry, struct fileattr *fa) { @@ -127,7 +131,12 @@ int nilfs_fileattr_get(struct dentry *dentry, struct f= ileattr *fa) } =20 /** - * nilfs_fileattr_set - ioctl to support chattr + * nilfs_fileattr_set - change miscellaneous file attributes + * @idmap: idmap of the mount + * @dentry: the object to change + * @fa: fileattr pointer + * + * Return: 0 on success, or a negative error code on failure. */ int nilfs_fileattr_set(struct mnt_idmap *idmap, struct dentry *dentry, struct fileattr *fa) @@ -160,6 +169,10 @@ int nilfs_fileattr_set(struct mnt_idmap *idmap, =20 /** * nilfs_ioctl_getversion - get info about a file's version (generation nu= mber) + * @inode: inode object + * @argp: userspace memory where the generation number of @inode is stored + * + * Return: 0 on success, or %-EFAULT on error. */ static int nilfs_ioctl_getversion(struct inode *inode, void __user *argp) { --=20 2.34.1 From nobody Sat Feb 7 08:23:03 2026 Received: from mail-pf1-f175.google.com (mail-pf1-f175.google.com [209.85.210.175]) (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 8505D145B23; Fri, 16 Aug 2024 07:43:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.175 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794219; cv=none; b=hYkFL3G9bEJ/AyuJgeTF7qaaZSZ+KUf160jPJp5a8yY1i6bBsv4K9YMMQXKNICdn1I7L7PTMhwYKhoCzCbgIvdfK1SKnYsAFgNtEdCJOIZioAUnhC4FpGx/VPiwa+Th4dEta6thv70bLHb0cN69zoVEUnaibw2nSHoEwjY5bSPk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794219; c=relaxed/simple; bh=ZxrL3hH0pVt0JDnnRDdHkN81lAhlOawK6z//FKuUrhk=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=dUJ9P1gXNY56TFMsi18jdTaxy4150zIvM90FFN/PiEEN6hmrnvIYdMUyG7oDSxZZuWHP+jQuE+3Qdmt1MX6uAEEG2IHzytExMU7G2V+3xPZz0g3Ukvh3J/FbUSyBJ1PWmjaL1/c8BemzwX44IJf26eQdviLamOK6UpLvNhShvlA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=nmtX/Hzh; arc=none smtp.client-ip=209.85.210.175 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="nmtX/Hzh" Received: by mail-pf1-f175.google.com with SMTP id d2e1a72fcca58-710e39961f4so1286305b3a.3; Fri, 16 Aug 2024 00:43:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794217; x=1724399017; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=DZqnDzdx2eoVGdt+SqB5/B/a67w1gWDZf/LKp/84mBQ=; b=nmtX/HzhcYOTi96H335bE98aczTj62oc4H7iElYxCZaqXCuoa5ecaMhf8iGm1tEAS/ leCxZX2TjWFMjQRKk97HUf7HaikxiODjNKNtqf7XDXI34bCwHoFqeE/hSBH6mk2hoxvw zRdgI8ojBkaaQ6SInJptKHYOcFzD98mAGUkHw0lhvUS7JfStwR8S5VsHYl1hYb6k0IES HT1zjGCt3KDIvLupyasap2j409waqzYLlQY0IDiaMYKmSpAaFeuD9+EfZt8bSqAH1Pd7 y4rliY+LzwE+6SbecI5xvJFZ3xUDNRPoRdUeeXI2THsw4tENjKiVFYZvs1ODF6jsq0aK gQkA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794217; x=1724399017; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=DZqnDzdx2eoVGdt+SqB5/B/a67w1gWDZf/LKp/84mBQ=; b=sxZqcLoO6FR2eLU78Urw/ADrBbn/UyFr/AzgIlX78w2AQlfcHSRMYuM7uVldLAnYXL rRWLxUIuypl0xa5iTjr5yIuSrPhSlfRl3BxGqLTxI9K5MxlxRBSEcwFfG0rlGf1yoPM3 8AU+vueKm4mQ8HuppCG/HQWq0CQw7wJTkBYnZLXvg1+ZN6HASUwm6lPnt7Dfl3rdWwQ4 ASm2k/Lw9VvwXOtmCzog0bOg5OMHei3HNTigdzdJzzY6/Jnvp7enxYl89n0mbKqse/6E ZBWJ0I/Y1CMa8+yi7TlWlqtE2tIi8SnomlXL1OzWa5j37+Q0r+vDgrRa0kB/mosH2ANs ZXIA== X-Forwarded-Encrypted: i=1; AJvYcCUkaRNO8FzLnvZkQxTJKFyeO2vuLzzoFyFkvrVMhfkvjasWMQXGQTqWmIuHESyq+fBfNkNu05zI0Y4cgyFNKBe/i9svsPBqFiALoCL6 X-Gm-Message-State: AOJu0Yzka+OEsokAO0bcE6m+5L9K7Fm4MtsPvyHBL0sMRbNPu2/t51Ab NHu1AW8XXG3HoKAdlAmtwGSIAOYHvV/767OtFarfVUGgVqYP1VErwnjP2Q== X-Google-Smtp-Source: AGHT+IFcPmiaqxUeM6ecOB7FlhpSq6a7w5AoF224U1Ll5V6tbIDfFQ/MFE1GDCDOXahUqCfjj9wrnw== X-Received: by 2002:a05:6a00:1409:b0:712:7319:6f53 with SMTP id d2e1a72fcca58-713c5296aa8mr2150046b3a.30.1723794216617; Fri, 16 Aug 2024 00:43:36 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:35 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 3/8] nilfs2: improve kernel-doc comments for b-tree node helpers Date: Fri, 16 Aug 2024 16:43:14 +0900 Message-Id: <20240816074319.3253-4-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Revise kernel-doc comments for helper functions related to changing the search key for b-tree node blocks, and eliminate the following warnings output by the kernel-doc script: fs/nilfs2/btnode.c:175: warning: Function parameter or struct member 'btnc' not described in 'nilfs_btnode_prepare_change_key' fs/nilfs2/btnode.c:175: warning: Function parameter or struct member 'ctxt' not described in 'nilfs_btnode_prepare_change_key' fs/nilfs2/btnode.c:238: warning: Function parameter or struct member 'btnc' not described in 'nilfs_btnode_commit_change_key' fs/nilfs2/btnode.c:238: warning: Function parameter or struct member 'ctxt' not described in 'nilfs_btnode_commit_change_key' fs/nilfs2/btnode.c:278: warning: Function parameter or struct member 'btnc' not described in 'nilfs_btnode_abort_change_key' fs/nilfs2/btnode.c:278: warning: Function parameter or struct member 'ctxt' not described in 'nilfs_btnode_abort_change_key' Signed-off-by: Ryusuke Konishi --- fs/nilfs2/btnode.c | 63 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 54 insertions(+), 9 deletions(-) diff --git a/fs/nilfs2/btnode.c b/fs/nilfs2/btnode.c index c034080c334b..57b4af5ad646 100644 --- a/fs/nilfs2/btnode.c +++ b/fs/nilfs2/btnode.c @@ -179,11 +179,32 @@ void nilfs_btnode_delete(struct buffer_head *bh) } =20 /** - * nilfs_btnode_prepare_change_key - * prepare to move contents of the block for old key to one of new key. - * the old buffer will not be removed, but might be reused for new buffer. - * it might return -ENOMEM because of memory allocation errors, - * and might return -EIO because of disk read errors. + * nilfs_btnode_prepare_change_key - prepare to change the search key of a + * b-tree node block + * @btnc: page cache in which the b-tree node block is buffered + * @ctxt: structure for exchanging context information for key change + * + * nilfs_btnode_prepare_change_key() prepares to move the contents of the + * b-tree node block of the old key given in the "oldkey" member of @ctxt = to + * the position of the new key given in the "newkey" member of @ctxt in the + * page cache @btnc. Here, the key of the block is an index in units of + * blocks, and if the page and block sizes match, it matches the page index + * in the page cache. + * + * If the page size and block size match, this function attempts to move t= he + * entire folio, and in preparation for this, inserts the original folio i= nto + * the new index of the cache. If this insertion fails or if the page size + * and block size are different, it falls back to a copy preparation using + * nilfs_btnode_create_block(), inserts a new block at the position + * corresponding to "newkey", and stores the buffer head pointer in the + * "newbh" member of @ctxt. + * + * Note that the current implementation does not support folio sizes larger + * than the page size. + * + * Return: 0 on success, or the following negative error code on failure. + * * %-EIO - I/O error (metadata corruption). + * * %-ENOMEM - Insufficient memory available. */ int nilfs_btnode_prepare_change_key(struct address_space *btnc, struct nilfs_btnode_chkey_ctxt *ctxt) @@ -245,8 +266,21 @@ int nilfs_btnode_prepare_change_key(struct address_spa= ce *btnc, } =20 /** - * nilfs_btnode_commit_change_key - * commit the change_key operation prepared by prepare_change_key(). + * nilfs_btnode_commit_change_key - commit the change of the search key of + * a b-tree node block + * @btnc: page cache in which the b-tree node block is buffered + * @ctxt: structure for exchanging context information for key change + * + * nilfs_btnode_commit_change_key() executes the key change based on the + * context @ctxt prepared by nilfs_btnode_prepare_change_key(). If no val= id + * block buffer is prepared in "newbh" of @ctxt (i.e., a full folio move), + * this function removes the folio from the old index and completes the mo= ve. + * Otherwise, it copies the block data and inherited flag states of "oldbh" + * to "newbh" and clears the "oldbh" from the cache. In either case, the + * relocated buffer is marked as dirty. + * + * As with nilfs_btnode_prepare_change_key(), the current implementation d= oes + * not support folio sizes larger than the page size. */ void nilfs_btnode_commit_change_key(struct address_space *btnc, struct nilfs_btnode_chkey_ctxt *ctxt) @@ -285,8 +319,19 @@ void nilfs_btnode_commit_change_key(struct address_spa= ce *btnc, } =20 /** - * nilfs_btnode_abort_change_key - * abort the change_key operation prepared by prepare_change_key(). + * nilfs_btnode_abort_change_key - abort the change of the search key of a + * b-tree node block + * @btnc: page cache in which the b-tree node block is buffered + * @ctxt: structure for exchanging context information for key change + * + * nilfs_btnode_abort_change_key() cancels the key change associated with = the + * context @ctxt prepared via nilfs_btnode_prepare_change_key() and perfor= ms + * any necessary cleanup. If no valid block buffer is prepared in "newbh"= of + * @ctxt, this function removes the folio from the destination index and a= borts + * the move. Otherwise, it clears "newbh" from the cache. + * + * As with nilfs_btnode_prepare_change_key(), the current implementation d= oes + * not support folio sizes larger than the page size. */ void nilfs_btnode_abort_change_key(struct address_space *btnc, struct nilfs_btnode_chkey_ctxt *ctxt) --=20 2.34.1 From nobody Sat Feb 7 08:23:03 2026 Received: from mail-oi1-f176.google.com (mail-oi1-f176.google.com [209.85.167.176]) (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 E0FA21474BF; Fri, 16 Aug 2024 07:43:39 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794221; cv=none; b=VnG1azXAHg2e4cU5kXJD7zrY30gxc+WSUoDwzoyijpYo2WGovzze2xX5+4rHcsZLUkFO3HokCL+n0y+lymA22+M1kZ+wf7QEribo4liyhJsmBDJD8I04zYxN17jWMHNeOJXAwsZb6ta3tcyFKDvm5Hnn3PXHXkrUHUhiKxPSFA0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794221; c=relaxed/simple; bh=xvXyKWVZ+d9kg2SSupKpqjfvyUo8DmAwO6aYVXqoCnE=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=exy/FzLgrCoPCGVv5XdS6OBeRmv6sDDMzm76D6zmGbWXGdLgG1ZUfKU+uroKLy2P6SYeZRXVUKzxS5QFzJMB+hHJu6aFzhJtf4T0OIZH9WSlVZPxLyTGvozDTLJs+KVb81CKzcYy+VQGXK5c71wgHeBxFakieAMMc9SQJ/Hs2DM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=b0Ik7EdR; arc=none smtp.client-ip=209.85.167.176 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="b0Ik7EdR" Received: by mail-oi1-f176.google.com with SMTP id 5614622812f47-3db23a60850so1112842b6e.0; Fri, 16 Aug 2024 00:43:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794219; x=1724399019; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=hqvvbDmipCYRQJs4dUhqHplYgkK+QiaGsdcJMKDqZW8=; b=b0Ik7EdRfrizwDN1RJNMXH+hjib3WHnILX/s0WXXAneSBSUp/jEBBIYODdCrfn1gPL c027CBYYiSYrVFqaju4tbOfvCmPjMyv1fF1/xPA+E6t0o7XLaz4ABHKKUtEz5upfDwR6 6zis2O6+Eit8U1yeHduo7NTcY9s1rxooKYM1HPamewtM1ojFmgs3ZBcarBaE1u9mBRQW v+EqKRJBC7BiacNeK+McIqVS+8LWmy8QldFJwQOBv+Rvg+xYuo9IrK+QdpCsNxRWA6Br ojRf/y2Yyl7wP1f9RPpL7veNS+q1aFYqS0pD9u4LKB+hKywRomN7swHqF7kGVqaZ8I30 ctZQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794219; x=1724399019; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=hqvvbDmipCYRQJs4dUhqHplYgkK+QiaGsdcJMKDqZW8=; b=Jlo8RmQKF/ae9fwcmExiez0IJFxmDG3Sb6pLInl+yQ+yO1aOZFYMkwdFIBULbe+Nch AywCk8yzToCcCVlZOdaNYB/c5D6OPGixxbr3FRlzbF8VclRV7UD5NA2Subfz0QG2I7Fg FvWiA5KUKs+nsDQkJ+GKmEDi6NZfQbpywgYgJTRJub8BK251KjOgNci0tUrulyEXakq7 YZjaYXv5w+e+YeAtFXfmpjfeXqguESxyO2cHf4UIoMRJ7bfsRjN6MHdMGa7rZx5otVU1 bWlyAO4j0ZfjQ+G0AZ3q56gU9gPOLvuxFk+3/Eo61yadoi4sE6p/WTXHTYESjHs45kvJ RO6w== X-Forwarded-Encrypted: i=1; AJvYcCUTztxIXk+SXXkCuEZZ1w+jMeiCWQw/F5sofQKQXs4WX1SqzU/k6/eHz3GQ4EAEzObnzkDSwP7/CH0TdLd4imn70sSuWU+SN50t9YYC X-Gm-Message-State: AOJu0YwixrSAHIgSJSZ2gOpKUOhxKOoT3CVBpU24kU09qHthAQy7oCDn HQf4ycfRcbdQJSznRJ4ysLBhVEcyRhCw8nwf6Jw187H36ITtu/qv X-Google-Smtp-Source: AGHT+IEa0L0dIkPYFZco5UgxCnU+zGCuUsA7F4ELG7r0fVIpfddVG8AN2auYz2TwDKW+XxB86Ahfmw== X-Received: by 2002:a05:6808:1b1f:b0:3da:a16e:1759 with SMTP id 5614622812f47-3dd3ae45c95mr1843917b6e.48.1723794218777; Fri, 16 Aug 2024 00:43:38 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:38 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 4/8] nilfs2: fix incorrect kernel-doc declaration of nilfs_palloc_req structure Date: Fri, 16 Aug 2024 16:43:15 +0900 Message-Id: <20240816074319.3253-5-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" The "struct" keyword is missing from the kernel-doc comment of the nilfs_palloc_req structure, so add it to eliminate the following warning output by the kernel-doc script: fs/nilfs2/alloc.h:46: warning: cannot understand function prototype: 'struct nilfs_palloc_req ' Signed-off-by: Ryusuke Konishi --- fs/nilfs2/alloc.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs/nilfs2/alloc.h b/fs/nilfs2/alloc.h index d825a9faca6d..e19d7eb10084 100644 --- a/fs/nilfs2/alloc.h +++ b/fs/nilfs2/alloc.h @@ -37,7 +37,7 @@ void *nilfs_palloc_block_get_entry(const struct inode *, = __u64, int nilfs_palloc_count_max_entries(struct inode *, u64, u64 *); =20 /** - * nilfs_palloc_req - persistent allocator request and reply + * struct nilfs_palloc_req - persistent allocator request and reply * @pr_entry_nr: entry number (vblocknr or inode number) * @pr_desc_bh: buffer head of the buffer containing block group descripto= rs * @pr_bitmap_bh: buffer head of the buffer containing a block group bitmap --=20 2.34.1 From nobody Sat Feb 7 08:23:03 2026 Received: from mail-oi1-f176.google.com (mail-oi1-f176.google.com [209.85.167.176]) (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 E2B401494AC; Fri, 16 Aug 2024 07:43:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794224; cv=none; b=jSngcbLEFE1xo8DXXQmWLBpAwLTALvAyPQQDTtZ+VYNJ0usqZ2GUKg2qpemCWoXWmb9I1yFAUj/lZDRNP5IktsLoA7d7j3yS0wHafTQiAuZSn/KpZSNiTtWpr1WF4BYucmab5VoYfhjJK4VJhJNxjwYvgtI705+VOItNMkh3Iyw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794224; c=relaxed/simple; bh=d2TlnbwTBK2JYwlfptEuI9Zy8jS6k77+C5E/10Wi1pg=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=iSBR+7GMS7Kd0MhjIjRJGvYxhX60QV/KmDi1wAxly3d6/AajNtZ08UXIzgCbd3KqbR8HeZpUCZldPpK1k0ByYPBZ+SY/CNmPEiDI8/VMRgg7DoN3rTQpVPs31wgtHUXVpV0pmGDJxY1ky3ZFJAp5297crGC3GkGXwFkQ/DjCbxQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=LShvRTmK; arc=none smtp.client-ip=209.85.167.176 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="LShvRTmK" Received: by mail-oi1-f176.google.com with SMTP id 5614622812f47-3db1956643bso1092794b6e.3; Fri, 16 Aug 2024 00:43:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794221; x=1724399021; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=SnrqputMzVeb+Pe5/Tf78NeSauXPf5xkVwyJAK2U1zA=; b=LShvRTmK9H94K2HEf4Guxu+r4KKrEpBmUzywChdlmt2Zs9V83WDs4C/BwpPVhBS4XZ /NN+XInx24WUSIpR+FR0M/qL5WLF5oNwdfdG0GSr67FYiz9ml5PNZ42X6ALb/OBEtCeg JVW6WNwD/D1qLD5OFQXsmhvS/zlBQw1CJhhq5cW1ZRhOZnqvLbRxrnoHxAKQosfoxuY1 ARmSxdK1HKVZ8ePbrGy5jrfd/MlKBnN3fK/CESyPGVN6ODcWq2hzi3zh8fGzeouFwhUp MWt+VOd2D9HXkzs0Zq2bJEtvQ5DU/a2/702G6Id/5p4Frb62Kxu3C2Hz/bkkCgs2I1LU Y+Cg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794221; x=1724399021; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=SnrqputMzVeb+Pe5/Tf78NeSauXPf5xkVwyJAK2U1zA=; b=bc0LYwsPUaRklryeyR/i9OQsCFlgCOVi9KQT1rFP+DBNXHsUhP+CeKcsSabF3/VSzi ZGljIgLkERSYiUhpuEcduvC0RXcybTW1G6HTKcE/sh8GiSDPda4ygDj4kpIJq6ly9cK1 j14hp2g5rAnmngqwfADKRJZSSrmLXdUj7qi6uJbmDUpt6lT1KO+TJSC/k0ZXF8Gv7WDA bTwcMMu8PulifS9Q/45QyEDz5W8bPcWm+wzTtFJSbdjCtdQI18Pof6aonqFpNMfzx4P5 kikQ3SdpNCCxYLFALF2IFAquXxE7s/wRbEP83GFyVCAK1GYFUtDrCdGti1/1XqrhRIAH XdyA== X-Forwarded-Encrypted: i=1; AJvYcCVtq0cSaFuOUE3/bg/5yo7dnBcWNooC95mtu29H4NA+HfMnbuTIYNeBbICYaHdDrHD8IDcwx027591iu5BzqcV45gOAPLTUbebcv1+K X-Gm-Message-State: AOJu0YyL/VqAVS474aw2cwYd6VmylS+CWdwu5VdXIVxDxi11pdYpWZrx tbXmOGJolheQhMKq20GA3ng3Cyub5uqIXL4GtfLwvkE6yMiDPHHN4unbIg== X-Google-Smtp-Source: AGHT+IEY/CQUFGdxkonxE+EU5Oj4AViY2IsRD8KpOwnFyTJUCoXjPgvBGG1wqfpfbbNNwhb4VInH6A== X-Received: by 2002:a05:6808:1928:b0:3da:aac7:4380 with SMTP id 5614622812f47-3dd3aceab22mr1889285b6e.11.1723794220901; Fri, 16 Aug 2024 00:43:40 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:40 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 5/8] nilfs2: add missing description of nilfs_btree_path structure Date: Fri, 16 Aug 2024 16:43:16 +0900 Message-Id: <20240816074319.3253-6-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add missing kernel-doc comment for the 'bp_ctxt' member variable of the nilfs_btree_path structure, and eliminate the following warning output by the kenrel-doc script: fs/nilfs2/btree.h:39: warning: Function parameter or struct member 'bp_ctxt' not described in 'nilfs_btree_path' Signed-off-by: Ryusuke Konishi --- fs/nilfs2/btree.h | 1 + 1 file changed, 1 insertion(+) diff --git a/fs/nilfs2/btree.h b/fs/nilfs2/btree.h index 92868e1a48ca..2a220f716c91 100644 --- a/fs/nilfs2/btree.h +++ b/fs/nilfs2/btree.h @@ -24,6 +24,7 @@ * @bp_index: index of child node * @bp_oldreq: ptr end request for old ptr * @bp_newreq: ptr alloc request for new ptr + * @bp_ctxt: context information for changing the key of a b-tree node blo= ck * @bp_op: rebalance operation */ struct nilfs_btree_path { --=20 2.34.1 From nobody Sat Feb 7 08:23:03 2026 Received: from mail-ot1-f42.google.com (mail-ot1-f42.google.com [209.85.210.42]) (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 F3E57149C78; Fri, 16 Aug 2024 07:43:43 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.42 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794225; cv=none; b=OkEQtO8qtmWfPvpUwOVlwg1JFs1mkI1CqvKX14hdGSpTzqw2NNGbwY+bFuId3kbJNu8En096ICD1iQJMqGDhq4//1Gn1xEwwC23XrpZKDWNX2KGe6C345bSYFw5ynNoAHLfu7cw6AZGU5D+vU1Cs1ofdisNB6SGceXJMq84pSdk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794225; c=relaxed/simple; bh=8LyhGFbg1RVPlDjb0DjIHDQvXGoTj8wHjgO2lZc1TDs=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=LkEWME+tE1ID8z2br3xLd2X5Ye0a10Mv52vtcG6A+15JkjkuYk8lFntd+ntgn8ZTmDbE4unlIYaOG4mFYgh+/LGvlVcWJLmXpvRRc6oJ8Q+C7QxIW73QehHiyjMuDfYCFLAHvGd90Q+H5+aLXUsIcm85twTq6Dj9U+9vTnDdxdI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=fQTWsPU6; arc=none smtp.client-ip=209.85.210.42 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="fQTWsPU6" Received: by mail-ot1-f42.google.com with SMTP id 46e09a7af769-7093705c708so1725135a34.1; Fri, 16 Aug 2024 00:43:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794223; x=1724399023; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=fNzlLWESxG/0bPC91zjV9bHsAzub7Pn/mV51bKr3ejI=; b=fQTWsPU6LT4kar3UPa23CaxJ16v81NZEC69yhyDY8ozazZcz3IfWNK+Z7nrYyxvNpe ykusC5PIfy54rRzQeVWGNI6HdV1mwJfBVru/yhGfujN+Y5IRyWHu/aMXcoSbmhg9HTmm aOd7poaTGdcrLiFLghA4J5cxjWga7Asdez0KCLMXjd34JF/kL9hc5M/xAS7QCww/41PF gAHaJkf3lqr5bv+cuMw5AODcR2fPrq8FtVUVhdkfWl32m9C5u9g+uTItzOzVoZER0IqO xHmAJRck32t/77UP4TMa+7B2Cq5NpJPYqiOyasZ3vrwBntlK9xNzQzpM/ok6zHyVwHhS wn6A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794223; x=1724399023; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=fNzlLWESxG/0bPC91zjV9bHsAzub7Pn/mV51bKr3ejI=; b=qA+ocr1DvdiSzb+WuIbP8E7WTjwmpfnKynXup1OhnMBy7wpokYC9rsz0E724AF0MBJ 0vcZs/VzWYLgBRAE/pDaftpel9N0jpWNpVd6PiBtI/2w5oYm5VM+xBtsn79mbtFm1Lbl n83mrDmRoCjqxdL4NspOvYLnhuzh54zE6Pj5KjHa9u+r8j/7mY3YBCt2RvNJXn0M5GRL aSHRLF2KsPKD8zrSFvbTnNDqtg8Klvhe/i4JlqZ8zC2z5IkYTGMYvFq7sAF+Zf6WaG7A K2lVyn+sQ0MiDw5qh73JRA/W+v0n+fQl4Nhp0AONBeGR5558dbJZKokQ6N34iJuFxRsU zTxw== X-Forwarded-Encrypted: i=1; AJvYcCX8oscEjrsY4hHKZ2X+idIPrBrFNeiSit0fQBX3RDG5asdfAxJQxKHG7wJ3ClpVIqG1LCxVZNtZLXjfabMhZ6NG0DcD3aZ8IBC+TE4G X-Gm-Message-State: AOJu0Yy4LYLgbXVJkHzf7VfqIFjOhHAPSZ4Zg2L9BAzvaGbZOM1I6ZiA n5eO5NRpM/QEXapaK5DI0EnfIvBnsgZ+QQQJJ+BmwedbTLur2HtRaCVEsQ== X-Google-Smtp-Source: AGHT+IEJpVnX9qqYY+I9fLmZoBi0WpcvZpotWxXq33gmbREdf7h+QlQ8gi/kOA8f2ZEMxephjWmb9w== X-Received: by 2002:a05:6830:6308:b0:709:3150:1f2a with SMTP id 46e09a7af769-70cac8d3c3bmr2329761a34.34.1723794223004; Fri, 16 Aug 2024 00:43:43 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:42 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 6/8] nilfs2: describe the members of nilfs_bmap_operations structure Date: Fri, 16 Aug 2024 16:43:17 +0900 Message-Id: <20240816074319.3253-7-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add missing member variable descriptions in the kernel-doc comments for the nilfs_bmap_operations structure, hiding the internal operations with the "private:" tag. This eliminates the following warnings output by the kernel-doc script: fs/nilfs2/bmap.h:74: warning: Function parameter or struct member 'bop_lookup' not described in 'nilfs_bmap_operations' fs/nilfs2/bmap.h:74: warning: Function parameter or struct member 'bop_lookup_contig' not described in 'nilfs_bmap_operations' ... fs/nilfs2/bmap.h:74: warning: Function parameter or struct member 'bop_gather_data' not described in 'nilfs_bmap_operations' Signed-off-by: Ryusuke Konishi --- fs/nilfs2/bmap.h | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/fs/nilfs2/bmap.h b/fs/nilfs2/bmap.h index 608168a5cb88..5f8c8c552620 100644 --- a/fs/nilfs2/bmap.h +++ b/fs/nilfs2/bmap.h @@ -44,6 +44,19 @@ struct nilfs_bmap_stats { =20 /** * struct nilfs_bmap_operations - bmap operation table + * @bop_lookup: single block search operation + * @bop_lookup_contig: consecutive block search operation + * @bop_insert: block insertion operation + * @bop_delete: block delete operation + * @bop_clear: block mapping resource release operation + * @bop_propagate: operation to propagate dirty state towards t= he + * mapping root + * @bop_lookup_dirty_buffers: operation to collect dirty block buffers + * @bop_assign: disk block address assignment operation + * @bop_mark: operation to mark in-use blocks as dirty for + * relocation by GC + * @bop_seek_key: find valid block key operation + * @bop_last_key: find last valid block key operation */ struct nilfs_bmap_operations { int (*bop_lookup)(const struct nilfs_bmap *, __u64, int, __u64 *); @@ -66,7 +79,7 @@ struct nilfs_bmap_operations { int (*bop_seek_key)(const struct nilfs_bmap *, __u64, __u64 *); int (*bop_last_key)(const struct nilfs_bmap *, __u64 *); =20 - /* The following functions are internal use only. */ + /* private: internal use only */ int (*bop_check_insert)(const struct nilfs_bmap *, __u64); int (*bop_check_delete)(struct nilfs_bmap *, __u64); int (*bop_gather_data)(struct nilfs_bmap *, __u64 *, __u64 *, int); --=20 2.34.1 From nobody Sat Feb 7 08:23:03 2026 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 490CC15625A; Fri, 16 Aug 2024 07:43:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.170 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794227; cv=none; b=PNff1bwJd0dgXusSE72c6UuwzqliagARFrgwFA8undK5rakZ0pe0PbrfzmIbVcjGU79oQILcJ3hqd7C4agf4fIN6u9GJoiYSeSMbADmjP92tQwik3MQYy72dUBFv0mnszARJ8mfM0iz4fNtB/2QkOkakCeb9htLQyFhl1QGTCLw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794227; c=relaxed/simple; bh=kiKWKAUAbvAlluI6kaAn6cBCa9AkXQOWjGozLNZUXCw=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=mb17zi0aw8VPUltcF1OW5PR7vG/Unh5948+/OWKlAh5LRKBiIdcNrSKLOXqSakCLdYFbmTyMG61pyj1I0N8TGV5JySYWaJ0ec6bVH3Y6x2zIY6DDKLcORB398hInheUKN4MQ+TSgkbfeWrhU03wHDU0phkgGupyr0FrxcBWm84E= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=Xx15G8cs; arc=none smtp.client-ip=209.85.167.170 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Xx15G8cs" Received: by mail-oi1-f170.google.com with SMTP id 5614622812f47-3db14cc9066so1137923b6e.3; Fri, 16 Aug 2024 00:43:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794225; x=1724399025; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Dop1h2/PH5d4ieq0SlCtOSrsPYAe02dXUT2sT+HcSoU=; b=Xx15G8cs5gkEaaFnJUTgWNfqP37c5PrJXez4iUfzbq09f3BX20917foHNfcpmKaCBQ mrjoY8vQCVW/3rZS7sObOzZfqfpt+VpGjgcCpbhoYeiFNSaQej7tX7jz+iYWrvpLEws7 3E0Dd4YUGME6QRumDSr/lOL4D6B8GVthPd0iq0WqAi5RYc3KMnMOQu+gsANvWm93Dvge xTtZWDAh1TFbhRGe9IiSJUkNGPvmncDxCV8uDXyb1M/lN7sKYjxqec5erHvmZzJOZlMb VpTCrdsDH2VuK33mmRw9GfJpKdxWIaPUjKCLcrcL3Q5K0o028eeLyZ9a7K8sJXmJRoT+ 8eMg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794225; x=1724399025; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Dop1h2/PH5d4ieq0SlCtOSrsPYAe02dXUT2sT+HcSoU=; b=FK9k6KrR8w7XGbY1MCU4vJFLl/y82XkxBl+kM6x4ynYWtGamNxpI4IC6nMIb1tkoJO hsnh/HdhYs5juWLAuKrYxJ9RoFOI0timtW3bwKc3fwV+zH/OuPzXCNg5d6dsr8LtHUTW EdhLN4hVwe2z9Dma5KZqn9dYsg88BvvmKrvPMQ7rLm6+QVkvM8eKzmxOOq/8hXwpSr76 ZvxetgCRjXx0gbcIyLjBLzLRq2F3YRV64DOtKzyYkrlWS1CKrXZm0WDXqaiMQ2L0058t 2nxGl8F5NPZpw8TvmPBaE+A43PArfOa5K4uoU+XyoV/Ngu2+//iHoBwWR5Fh2yb315vG KUsQ== X-Forwarded-Encrypted: i=1; AJvYcCXfUWL2cTCBR+lACpvOXYtfNkgjwuFcUyQ3WP5XDDfaUaOKQ+vjBRcDgKmyWlDhe+5kS8bytKxABD1UkrwZ0KClxZylM72pkStF/aQk X-Gm-Message-State: AOJu0YwJAVY8tWV30t5QMVeuhYaC5eA3C0XABGb4cnw0Hk0tyih8jy6R BbBN3C05kjwKvmZvP1wnSI6VX/bbcWklbuZCu4MKjZkI8z4T3ix87X160Q== X-Google-Smtp-Source: AGHT+IHB+DzmERb+l5GLvvTdYM55lX++XXZXDYD5ogb9ZeGrPSmM1CsrrdaamKCZJqWs1XKoJaoNkA== X-Received: by 2002:a05:6808:1a0a:b0:3db:15a9:4a1f with SMTP id 5614622812f47-3dd3af6af6emr1547459b6e.49.1723794225132; Fri, 16 Aug 2024 00:43:45 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:44 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 7/8] nilfs2: fix inconsistencies in kernel-doc comments in segment.h Date: Fri, 16 Aug 2024 16:43:18 +0900 Message-Id: <20240816074319.3253-8-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Fix incorrect or missing variable names in the member variable descriptions in the nilfs_recovery_info and nilfs_sc_info structures, thereby eliminating the following warnings output by the kernel-doc script: fs/nilfs2/segment.h:49: warning: Function parameter or struct member 'ri_cno' not described in 'nilfs_recovery_info' fs/nilfs2/segment.h:49: warning: Function parameter or struct member 'ri_lsegs_start_seq' not described in 'nilfs_recovery_info' fs/nilfs2/segment.h:49: warning: Excess struct member 'ri_ri_cno' description in 'nilfs_recovery_info' fs/nilfs2/segment.h:49: warning: Excess struct member 'ri_lseg_start_seq' description in 'nilfs_recovery_info' fs/nilfs2/segment.h:177: warning: Function parameter or struct member 'sc_seq_accepted' not described in 'nilfs_sc_info' fs/nilfs2/segment.h:177: warning: Function parameter or struct member 'sc_timer_task' not described in 'nilfs_sc_info' fs/nilfs2/segment.h:177: warning: Excess struct member 'sc_seq_accept' description in 'nilfs_sc_info' Signed-off-by: Ryusuke Konishi --- fs/nilfs2/segment.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/fs/nilfs2/segment.h b/fs/nilfs2/segment.h index 1060f72ebf5a..2499721ebcc9 100644 --- a/fs/nilfs2/segment.h +++ b/fs/nilfs2/segment.h @@ -22,10 +22,10 @@ struct nilfs_root; * struct nilfs_recovery_info - Recovery information * @ri_need_recovery: Recovery status * @ri_super_root: Block number of the last super root - * @ri_ri_cno: Number of the last checkpoint + * @ri_cno: Number of the last checkpoint * @ri_lsegs_start: Region for roll-forwarding (start block number) * @ri_lsegs_end: Region for roll-forwarding (end block number) - * @ri_lseg_start_seq: Sequence value of the segment at ri_lsegs_start + * @ri_lsegs_start_seq: Sequence value of the segment at ri_lsegs_start * @ri_used_segments: List of segments to be mark active * @ri_pseg_start: Block number of the last partial segment * @ri_seq: Sequence number on the last partial segment @@ -107,7 +107,7 @@ struct nilfs_segsum_pointer { * @sc_wait_daemon: Daemon wait queue * @sc_wait_task: Start/end wait queue to control segctord task * @sc_seq_request: Request counter - * @sc_seq_accept: Accepted request count + * @sc_seq_accepted: Accepted request count * @sc_seq_done: Completion counter * @sc_sync: Request of explicit sync operation * @sc_interval: Timeout value of background construction @@ -115,6 +115,7 @@ struct nilfs_segsum_pointer { * @sc_lseg_stime: Start time of the latest logical segment * @sc_watermark: Watermark for the number of dirty buffers * @sc_timer: Timer for segctord + * @sc_timer_task: Thread woken up by @sc_timer * @sc_task: current thread of segctord */ struct nilfs_sc_info { --=20 2.34.1 From nobody Sat Feb 7 08:23:03 2026 Received: from mail-oo1-f51.google.com (mail-oo1-f51.google.com [209.85.161.51]) (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 788F6156F33; Fri, 16 Aug 2024 07:43:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.161.51 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794230; cv=none; b=UPX4ty0u1IoHx5ttIevsxQ/X3U0OLPtHYe3Ws1jgknDeQFoMaVmwJQuHuYVyFfjG5F4r0pCSjYMb0zY7rfZnmO+Czo9nRC9KKO+g9ZNCqQU4Ceo7CeHJvSrdJkqASn6Oghi7f0TYUFWicgCYCbGy55c6evGkhLVv9ZP0Deuvin0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723794230; c=relaxed/simple; bh=UIbJ/uqoIosW5s1bUr03D7GTXRsDq9vJa4PH/arg0Gc=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=ZThEXcn7tnmepnWllAD/vT79hiSLB/GkcOlv8V0/vQEH8ShWgqvVH4um+nfyDA4ux/vZWyc1RVgkTArlmu3DNN4DgU8+C/ASLM9PpTeW1qm75pX7t4AwrNeq2xUtCrmy4RfPhBLhb1aSwxOtq/0UYdky+zVpcjDjj8RlcAp41bQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=ZS1y6Qi9; arc=none smtp.client-ip=209.85.161.51 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ZS1y6Qi9" Received: by mail-oo1-f51.google.com with SMTP id 006d021491bc7-5c661e75ff6so1045517eaf.2; Fri, 16 Aug 2024 00:43:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723794227; x=1724399027; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=bBKNk/g6wfoWgn/wh64t6+HoYfuxNxrmk+Ef10/o36c=; b=ZS1y6Qi9tf0SnldWxDKLKjIcwuO+0AjmDva2mlrLgBSco9scnkLuizxrgxUzoTYkIH RijNEyS30MYhWSV55vBCV6lQ4qjPKtdrZ3zB3DPoQqmSaYwtmeeULfZoG00HiL1mc6do MZVtgIPdD6PcSWCA4LyIMNpS2HQVjO4oVtNG6BVyplofHC31OY7IKte7giMdlQEtbpwE CnmlG192lsM+HuKIMgk6ZC5D7TU5hXK1whzlBAZIRe1YAqwdxrf8UZj8OxCvmuOgez9j JkeTfO9JqADJUCnE2+vx/4LFvAnyi7c13W2Am3abVeVp5/TNA7M+9iDwOt8FCeTEnqS2 B6eA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723794227; x=1724399027; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=bBKNk/g6wfoWgn/wh64t6+HoYfuxNxrmk+Ef10/o36c=; b=YnPKIWfQE+BRQ8kPCp4mtRsu+XZeRCgQTO1BIqjwrtXX8B/qqXvG+8czyf3JPu5UgP 7Ti6A3cetEgaZlIehU6zVfvZoFq9KC48fWQFu1wVbX7EqV4udqobpn3uAupmtEiApa39 lGs3y+a5Zw7NqAHQmsgrxNXaX2yzb6rnZduM/PR3SA7LOYwROXZRzQvclFzaa1eVuAm3 s/g+h8BGCMP47fFhs4TWG+agMfTHuaolpp9CVM9TYDWGQZZB1gn14RWKfLR/pJa2XgDO LG8bGzJMZKvPdDm2SXxngAK/PATVbc15TuXoxiW6hwmwh9nu+vxY0jBU5dKJl/hW9Wes xouQ== X-Forwarded-Encrypted: i=1; AJvYcCU//Pl2ONuQftOiK6+BBdrAsOwnf3c6PTokSbLgQKIwhRNDDN9PlpcIBeASxH4fgMAp0yAjlqW590XeaLTfqGavBC+yOEemj4WAbxje X-Gm-Message-State: AOJu0Yz44UZk+NFPaKxU37H7nyJXOQlo+l/xMPFJERcP4AkJKCAOeeft elQwJCn+i8XBw16DXZV1J4pJ1Ny7la8yT5cl8T/jqhadJemNJIJEbHq9+Q== X-Google-Smtp-Source: AGHT+IFKkqHOCa/az0OeWpg9uNiDJszkj/MhcvEctit2vifjwjrtZgD935GfaRGfWByBZDl4Aks+Ew== X-Received: by 2002:a05:6870:1698:b0:261:6bc:9b8e with SMTP id 586e51a60fabf-2701c3f7b59mr2473932fac.26.1723794227398; Fri, 16 Aug 2024 00:43:47 -0700 (PDT) Received: from carrot.. (i222-151-34-139.s42.a014.ap.plala.or.jp. [222.151.34.139]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7c6b61e7c7asm2365971a12.45.2024.08.16.00.43.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 00:43:46 -0700 (PDT) From: Ryusuke Konishi To: Andrew Morton Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 8/8] nilfs2: fix missing initial short descriptions of kernel-doc comments Date: Fri, 16 Aug 2024 16:43:19 +0900 Message-Id: <20240816074319.3253-9-konishi.ryusuke@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com> References: <20240816074319.3253-1-konishi.ryusuke@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Update some kernel-doc comments that are missing the initial short description and fix the following warnings output by the kernel-doc script: fs/nilfs2/bmap.c:353: warning: missing initial short description on line: * nilfs_bmap_lookup_dirty_buffers - fs/nilfs2/cpfile.c:708: warning: missing initial short description on line: * nilfs_cpfile_delete_checkpoint - fs/nilfs2/cpfile.c:972: warning: missing initial short description on line: * nilfs_cpfile_is_snapshot - fs/nilfs2/dat.c:275: warning: missing initial short description on line: * nilfs_dat_mark_dirty - fs/nilfs2/sufile.c:844: warning: missing initial short description on line: * nilfs_sufile_get_suinfo - Signed-off-by: Ryusuke Konishi --- fs/nilfs2/bmap.c | 2 +- fs/nilfs2/cpfile.c | 32 ++++++++++++++++---------------- fs/nilfs2/dat.c | 17 +++++++---------- fs/nilfs2/sufile.c | 20 ++++++++------------ 4 files changed, 32 insertions(+), 39 deletions(-) diff --git a/fs/nilfs2/bmap.c b/fs/nilfs2/bmap.c index cd14ea25968c..c9e8d9a7d820 100644 --- a/fs/nilfs2/bmap.c +++ b/fs/nilfs2/bmap.c @@ -349,7 +349,7 @@ int nilfs_bmap_propagate(struct nilfs_bmap *bmap, struc= t buffer_head *bh) } =20 /** - * nilfs_bmap_lookup_dirty_buffers - + * nilfs_bmap_lookup_dirty_buffers - collect dirty block buffers * @bmap: bmap * @listp: pointer to buffer head list */ diff --git a/fs/nilfs2/cpfile.c b/fs/nilfs2/cpfile.c index 69a5cced1e84..9c8d531cffa7 100644 --- a/fs/nilfs2/cpfile.c +++ b/fs/nilfs2/cpfile.c @@ -704,9 +704,15 @@ ssize_t nilfs_cpfile_get_cpinfo(struct inode *cpfile, = __u64 *cnop, int mode, } =20 /** - * nilfs_cpfile_delete_checkpoint - - * @cpfile: - * @cno: + * nilfs_cpfile_delete_checkpoint - delete a checkpoint + * @cpfile: checkpoint file inode + * @cno: checkpoint number to delete + * + * Return: 0 on success, or the following negative error code on failure. + * * %-EBUSY - Checkpoint in use (snapshot specified). + * * %-EIO - I/O error (including metadata corruption). + * * %-ENOENT - No valid checkpoint found. + * * %-ENOMEM - Insufficient memory available. */ int nilfs_cpfile_delete_checkpoint(struct inode *cpfile, __u64 cno) { @@ -968,21 +974,15 @@ static int nilfs_cpfile_clear_snapshot(struct inode *= cpfile, __u64 cno) } =20 /** - * nilfs_cpfile_is_snapshot - + * nilfs_cpfile_is_snapshot - determine if checkpoint is a snapshot * @cpfile: inode of checkpoint file - * @cno: checkpoint number - * - * Description: - * - * Return Value: On success, 1 is returned if the checkpoint specified by - * @cno is a snapshot, or 0 if not. On error, one of the following negative - * error codes is returned. - * - * %-EIO - I/O error. - * - * %-ENOMEM - Insufficient amount of memory available. + * @cno: checkpoint number * - * %-ENOENT - No such checkpoint. + * Return: 1 if the checkpoint specified by @cno is a snapshot, 0 if not, = or + * the following negative error code on failure. + * * %-EIO - I/O error (including metadata corruption). + * * %-ENOENT - No such checkpoint. + * * %-ENOMEM - Insufficient memory available. */ int nilfs_cpfile_is_snapshot(struct inode *cpfile, __u64 cno) { diff --git a/fs/nilfs2/dat.c b/fs/nilfs2/dat.c index fc1caf63a42a..0bef662176a4 100644 --- a/fs/nilfs2/dat.c +++ b/fs/nilfs2/dat.c @@ -271,18 +271,15 @@ void nilfs_dat_abort_update(struct inode *dat, } =20 /** - * nilfs_dat_mark_dirty - - * @dat: DAT file inode + * nilfs_dat_mark_dirty - mark the DAT block buffer containing the specifi= ed + * virtual block address entry as dirty + * @dat: DAT file inode * @vblocknr: virtual block number * - * Description: - * - * Return Value: On success, 0 is returned. On error, one of the following - * negative error codes is returned. - * - * %-EIO - I/O error. - * - * %-ENOMEM - Insufficient amount of memory available. + * Return: 0 on success, or the following negative error code on failure. + * * %-EINVAL - Invalid DAT entry (internal code). + * * %-EIO - I/O error (including metadata corruption). + * * %-ENOMEM - Insufficient memory available. */ int nilfs_dat_mark_dirty(struct inode *dat, __u64 vblocknr) { diff --git a/fs/nilfs2/sufile.c b/fs/nilfs2/sufile.c index 6748218be7c5..7bfc0860acee 100644 --- a/fs/nilfs2/sufile.c +++ b/fs/nilfs2/sufile.c @@ -840,21 +840,17 @@ int nilfs_sufile_resize(struct inode *sufile, __u64 n= ewnsegs) } =20 /** - * nilfs_sufile_get_suinfo - + * nilfs_sufile_get_suinfo - get segment usage information * @sufile: inode of segment usage file * @segnum: segment number to start looking - * @buf: array of suinfo - * @sisz: byte size of suinfo - * @nsi: size of suinfo array + * @buf: array of suinfo + * @sisz: byte size of suinfo + * @nsi: size of suinfo array * - * Description: - * - * Return Value: On success, 0 is returned and .... On error, one of the - * following negative error codes is returned. - * - * %-EIO - I/O error. - * - * %-ENOMEM - Insufficient amount of memory available. + * Return: Count of segment usage info items stored in the output buffer on + * success, or the following negative error code on failure. + * * %-EIO - I/O error (including metadata corruption). + * * %-ENOMEM - Insufficient memory available. */ ssize_t nilfs_sufile_get_suinfo(struct inode *sufile, __u64 segnum, void *= buf, unsigned int sisz, size_t nsi) --=20 2.34.1