From nobody Sun Feb 8 09:37:32 2026 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 4CCAD165EFC for ; Sat, 11 Jan 2025 06:29:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736576950; cv=none; b=qJlhsJyGs4jYCcOs9GdSlk1T5C2rLQOyj6UtFhGu0m2owSTX0tAtNcLNi2pGDRUGt69AGxKI5MwsUL7ZhJfSo5yYT5X4QLlmgcMTevJ/1xyD6Wb321gq5UKqJNd1eWz2WBcS42Bi3zDxeqhr/3orEN8P/UZhHd0crOjhxhRU2Oc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736576950; c=relaxed/simple; bh=HqXt0cnv1V235N4XilQ093scHFfAMqEDlVlhpNQrUJA=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=bgh1y+w8cTrOXZwCUYCWBF4HjjCU89WPWsOB6p5Be7AG6Xvned4a5DmInDYaC24gEHuBHFdn6k3YBBLSNHyP4CEa8cThXpb1qbcLx9wFX2GKUF6p4aBEHmmGN/EZzsx573IrstwUU3E49lRChKgrFAlaT6r2XBmxHLOW2m2T0TA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=i/UBQAn9; arc=none smtp.client-ip=198.137.202.133 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="i/UBQAn9" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=xSQOsrwd/RhPONwMkU1DH8vbYOevqGD8EI5JkW9BxpU=; b=i/UBQAn9ywt6UIbJWJ6/z+190v U9o9lhQM9ggapRItG5GjgmeM8j0We/GgoZZ1PzEsvUTVvXvLoZZJx0n7BSg9ekWuh8Up7WBBShHjH tf3xgin663UqTcbxcKu917cekn3ZTnPjqwJtsZokXbP0mHp9NqhZ061ZS6+sd/SCxTVaQmXVmH8WY YWlQAYfW5Iabb3hstm/OLY6/x78igz+YeA8PElb3kH0MHV/KVJWwZacGRZJoEgP+Nmc+BnaHxaznS iVCzUrvlc8S1V4ZVsi3ZEkuuxwSDZOMC0p7mrA4/upBk8lNzOxn4Nq/+/vE1oxetqXZmqezv8DGw0 s3UpVP7Q==; Received: from [50.53.2.24] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.98 #2 (Red Hat Linux)) id 1tWUza-00000000HEd-1xSL; Sat, 11 Jan 2025 06:29:06 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Andrew Morton Subject: [PATCH] ipc/util.c: complete the kernel-doc function descriptions Date: Fri, 10 Jan 2025 22:29:05 -0800 Message-ID: <20250111062905.910576-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.47.1 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" Move the function descriptive comments so that they conform to kernel-doc format, eliminating the kernel-doc warnings. util.c:618: warning: missing initial short description on line: * ipc_obtain_object_idr util.c:640: warning: missing initial short description on line: * ipc_obtain_object_check Signed-off-by: Randy Dunlap Cc: Andrew Morton --- ipc/util.c | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) --- linux-next-20250108.orig/ipc/util.c +++ linux-next-20250108/ipc/util.c @@ -615,12 +615,11 @@ void ipc64_perm_to_ipc_perm(struct ipc64 } =20 /** - * ipc_obtain_object_idr + * ipc_obtain_object_idr - Look for an id in the ipc ids idr and + * return associated ipc object. * @ids: ipc identifier set * @id: ipc id to look for * - * Look for an id in the ipc ids idr and return associated ipc object. - * * Call inside the RCU critical section. * The ipc object is *not* locked on exit. */ @@ -637,13 +636,11 @@ struct kern_ipc_perm *ipc_obtain_object_ } =20 /** - * ipc_obtain_object_check + * ipc_obtain_object_check - Similar to ipc_obtain_object_idr() but + * also checks the ipc object sequence number. * @ids: ipc identifier set * @id: ipc id to look for * - * Similar to ipc_obtain_object_idr() but also checks the ipc object - * sequence number. - * * Call inside the RCU critical section. * The ipc object is *not* locked on exit. */