From nobody Fri Jul 24 05:21:38 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 4678647ACF2 for ; Thu, 23 Jul 2026 16:18:39 +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=1784823529; cv=none; b=g529ndAc7txF0PAWh+nEH1br1lbAiHgjyU9og1sbOhfDxoNBaMrKh7sWTp0IwYffAmNgh6oKLNnig2k+cFZZNRyERRaRJ/bxLSB1upNfOYC0vakMvlF5Mwg0aHzIW2pwB3Lv9TWX6Y7jgEJIM5OVmERtiESkKjq94Anl4qO0Hps= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1784823529; c=relaxed/simple; bh=C4uCeAkXKFQfwNSb+yhIALJw6F12knB2rhlPH0YQVLw=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=CNTdOv2P7dOFjFLt0ScAHBym7Auiq5tg7n69EGPokrX4S0D0i4YkyHV8ebwURe3YvCJ/h4NR/ThfHtxAwcZmZSIt23qvmudUgNdhqjpOoZ/xvp9cn2nMNN5/Dof3s7yes1wAaE/ZixD0EIhg9qLGlPjlNzZ8NF6YCCRhuOImV7U= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org; spf=pass smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=XlTsjfmI; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=pass 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="XlTsjfmI" 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=yw/BMpYMNtS9KbwaoorDWXb6sodPD/bavC8wFLe5BkE=; b=XlTsjfmI8YVjbu2VWgFcp0rdb1 QW7MIT+6NDdvh2tJZmKzXaTAnQdmYAbkvHwqN4V4GtZ7+bO6wBrRBeSj8s+Lu3r6wojz9KxeaRxmz rggL8RiNNuosV/JDviPnf70AoAYOWVI5eN+/NoSBkApeflvh0s39DhsWLPj7FmpQoc8bdy+NCRZnU qgKrlXLF+47QAWiKJNararKyJVhT/q+0Az2Asy0Xcg0QPr+wZ6dgwynQtlqxfoHnng0reo5vNczBF 0Bl8VUArIqDcCKdm9HDR1YO28+em0cLEyCcvac8b0VkF/PAs9LrSSAltMH7UIA/eS8nYrtE9imXeR HkLcCvoA==; Received: from [50.53.43.113] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.99.1 #2 (Red Hat Linux)) id 1wmw80-0000000EhZI-2raj; Thu, 23 Jul 2026 16:18:32 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Mark Rutland , Peter Zijlstra , Andrew Morton Subject: [PATCH] stacktrace: header: repair kernel-doc comments Date: Thu, 23 Jul 2026 09:18:31 -0700 Message-ID: <20260723161831.138237-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.55.0 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" - use the "typedef" keyword when describing a typedef - add a Returns: section to prevent these kernel-doc warnings: Warning: include/linux/stacktrace.h:20 function parameter 'stack_trace_consume_fn' not described in 'bool' Warning: include/linux/stacktrace.h:20 expecting prototype for stack_trace_consume_fn(). Prototype was for bool() instead Warning: include/linux/stacktrace.h:58 No description found for return value of 'arch_stack_walk_reliable' Signed-off-by: Randy Dunlap --- Cc: Mark Rutland Cc: Peter Zijlstra Cc: Andrew Morton include/linux/stacktrace.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) --- linux-next-20260722.orig/include/linux/stacktrace.h +++ linux-next-20260722/include/linux/stacktrace.h @@ -11,7 +11,7 @@ struct pt_regs; #ifdef CONFIG_ARCH_STACKWALK =20 /** - * stack_trace_consume_fn - Callback for arch_stack_walk() + * typedef stack_trace_consume_fn - Callback for arch_stack_walk() * @cookie: Caller supplied pointer handed back by arch_stack_walk() * @addr: The stack entry address to consume * @@ -48,9 +48,9 @@ void arch_stack_walk(stack_trace_consume * @consume_entry * @task: Pointer to a task struct, can be NULL * - * This function returns an error if it detects any unreliable + * Returns: a negative error code if it detects any unreliable * features of the stack. Otherwise it guarantees that the stack - * trace is reliable. + * trace is reliable and returns %0. * * If the task is not 'current', the caller *must* ensure the task is * inactive and its stack is pinned.