From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.remote-ip=202.12.124.158 ARC-Seal: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; cv=none; t=1795045508; b=e0Nbj3AVWXeGN31GuGmjAVqP+YPSlW3w0BFf2wpNRRXmUJP9oGtbmFfKm7msJTpxEHpt wgMxPiwp8GLfxD1LFnyq+VhAMK6+RJbBEsgoFDJEEDOMIQmy10Ad4HxXyAeTmFyPbDgQs FYCMSkppSKbifvRrxSWwEcdjqEPiu/+U4/TzrN41pGEmdWBD+YGPG6gqg0yKfAhnIqZgn +am8CQzDx329/V5qjn72KNKdhPpsxGYBt88Pcdd6HHDaosgZg3Ivl24eP4yzg+8368A4q Vv63Uz8y1fm/tUqazBxZFPsiMkCGZ+yeef0MHDay+beOQwxtVJFTfL+tFjBqCmiHkwQ== ARC-Message-Signature: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; c=relaxed/relaxed; t=1795045508; h=DMARC-Filter:Received:Received:DKIM-Signature:DKIM-Signature: X-DKIM2-Info:DKIM2-Signature:X-DKIM2-Info:Message-Instance: X-ME-Sender:X-ME-Received:X-ME-Proxy-Cause:X-ME-Proxy:Feedback-ID: Received:From:To:Cc:Subject:Date:Message-ID:X-Mailer:MIME-Version: Content-Transfer-Encoding; bh=SlvQ2VgnsFjXe3sW9Yw5Vu92DAnxWZkCnZJbEo3k38A=; b=eMTFCOHjD63LwmoGPJEsBDQWQtCRqbAyham8GtaNXlFrgNHoHhfXT6QO5bz1COgSUqDN W3Xwu6I/e7M10u/WrHmbrffWPDUwSg4rpSuxxt17iIcZIMOjc5cdd6WJjIEeDuTFXVXQc qmbXdsVB4Imy9hI/F35ddwcwYqcvLyf4uBXMwc4TJJgo+ED9b+J4J5OGqOWsrDxCv7k4+ zWS8IVJPfaFS4PvSlGE6eGWuNIqnnRxtGhvsrxKjxuBjFgQx7fKndtYC8wkp8h25wivM3 OwN4dgqsHZJmfVXZyWSP4E/kX9GDFK/eJnJ3sbNiqT+g520mWKggUKTu//I56rGUM6A== ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none header.from=flapping.org; spf=pass smtp.mailfrom=flapping.org; dkim=pass header.d=flapping.org header.i=@flapping.org header.a=rsa-sha256 header.s=fm2 header.b=dP2PLzA7; dkim=pass header.d=messagingengine.com header.i=@messagingengine.com header.a=rsa-sha256 header.s=fm3 header.b=hB8+2G5A; arc=none smtp.remote-ip=202.12.124.158 Received: from fhigh-b7-smtp.messagingengine.com (fhigh-b7-smtp.messagingengine.com [202.12.124.158]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2168D606A320 for ; Wed, 18 Nov 2026 23:45:06 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.2 smtp.subspace.kernel.org 2168D606A320 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=flapping.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flapping.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key, unprotected) header.d=flapping.org header.i=@flapping.org header.a=rsa-sha256 header.s=fm2 header.b=dP2PLzA7; dkim=pass (2048-bit key, unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.a=rsa-sha256 header.s=fm3 header.b=hB8+2G5A Received: from phl-compute-07.internal (phl-compute-07.internal [10.202.2.47]) by mailfhigh.stl.internal (Postfix) with ESMTP id 7DDF37A02D5 for ; Wed, 18 Nov 2026 18:45:06 -0500 (EST) Received: from phl-frontend-04 ([10.202.2.163]) by phl-compute-07.internal (MEProxy); Wed, 18 Nov 2026 18:45:06 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=flapping.org; h= cc:cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:message-id:mime-version:reply-to:subject:subject:to :to; s=fm2; t=1795045503; x=1795131903; bh=SlvQ2VgnsFjXe3sW9Yw5V u92DAnxWZkCnZJbEo3k38A=; b=dP2PLzA79OGnxZTiZT4meX2Jm/8OzMHkC3frv Q61M0XFL/zJqi11M9D3Y3E0ptf5dz2FA2ADj4Uer5pEsq8fDPWTeLLKYblTp7TZ6 GcCJ2Zu8Tonosyc0eiOdUBSMpOD+N5ciJ1rirAvCLfknBLtc9aBBz8mvyWRrIj2k btPLX778qRqDuN6aKZwOJg78iY/dMns9qd8yw4pbMGZSw6ZPuxGGKBoXb7na1N+2 gt5FxYIEBrOXCV/iXtHIxcocrzuwb4dCh/Q4iSyIkdYkcJnU+F8a+pexwqgLUuj5 WEWc/jk3lLoZsuQQZpYfTI0iSuJroDkjgmvWFdbK/ehUedheQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:message-id:mime-version:reply-to:subject:subject:to :to:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm3; t= 1795045503; x=1795131903; bh=SlvQ2VgnsFjXe3sW9Yw5Vu92DAnxWZkCnZJ bEo3k38A=; b=hB8+2G5Ati8KEnUIhjtPkTZFUJO/pSWajZ+YUJPWEnjkSIMDprC OYnGnyxqYyrhHGJN9PxUaGA7Z+64E3TIugasxOvfrzSRTGZUNJlfBpmdsWAgUkw8 89JYj7b3T2gyYBAfqFXleWoAOkZSZJfTR5ds95APr2B4ZQVCnylyBn1zAHdY7aWt 6oDnr/kW4BucEAQrb/h7nW9udXE3VQ4D5BcHMI6tAXd8PCoDNz9+cUDNnkiR7LHE YUQy+IiwC7FAPhOT+iwrR5CKFv30VBLGMHROgOUcOJz+qD+wLIk3BTiG0vx9XCvK 9UPMBSPYoA8wb4qJ846FULI4KkeodJIyXpw== X-DKIM2-Info: draft=ietf-dkim-dkim2-spec-09; repo=github.com/dkim2wg/interop; date=2026-11-03; sw=lmtpprox; action=sign d=flapping.org a=rsa-sha256; DKIM2-Signature: i=1; m=1; t=1795045503; d=flapping.org; mf=PHRvbW9AZmxhcHBpbmcub3JnPg==; rt=PGxpbnV4LWRvY0B2Z2VyLmtlcm5lbC5vcmc+; s=fm2:rsa-sha256:kQm+hXl9BJaF8oUxzA6qV74f2Je/XVeMoep8kvwdxmuo5YM zA5zBapsxM1iOFvCk7LVsDph6vWEO43iNtutOPOMg0awbcMBlBgfkX8E5rxrbBcv 0BdU/qUdUY/TQzhVgubmyK+CdtMSeDP3Y+0SDy7O1aOPmMFrvyxdGC67vCGH2NlD BSREGbhuA2Ws2BKH9FY0GCzsgouU0pU89kYYYDzTEB9lQ3wHE3C2oOG1xx9llLcP 25nv5eUzE0o4C6Owh9fR/HAQ7AanhIow5zLg9ToOlzD7hqfJKYTVXC1144Iia6xg ipXhtSEj7JNx/Cs6SO2pdg1BgwTGpQ5jODIhfLA==; X-DKIM2-Info: draft=ietf-dkim-dkim2-spec-09; repo=github.com/dkim2wg/interop; date=2026-11-03; sw=lmtpprox; action=mi-m=1; hc=9; hn=cc,content-transfer-encoding,date,feedback-id,from, message-id,mime-version,subject,to; Message-Instance: m=1; h=sha256:VdK/h2229Xpb2Ouscnrfx8QTL45tR//+A8G4qFlcrpY=:2WvQt4hIn1L1IHyMFwABT1ha26mfGUfohMSdBTOTfMo=; X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: dmFkZTE3oiK/yCDjq/eR3tM8m07M9PLaqebQ60WoFpU8jQdGzwP5oG0KL77CbdXuNDVoxI sNSobQBHfttlSTReoIBJCx5Oehf/7s8D+PMbiJskxJyRp2H545FxU+JC0U2to3P8DzSvm4 SmwehFw25/0ctu9/Zijqq2VNS5qplPqILZGGp1NG15PU8QxXJGqfZpfp7JlCOM0uJx7auH 3kpKTRSqeThx44OEZk4V7MN0KXixv7SP3/qTStUheREYrdRg/d6FDbkSKHDPvDXFbW09yH iaYKJ2BNI8EI7UMjXNWmy9VRpMvQTHtjWlD4/60FwmnOPYxMPfqtu/wkepZuYyV4Uwr/jh /q/AGzmazt/fhKlgfieFAk9gC//RTZVQNKmcEJ84gTmIVVfH//UsHv51O5mBetj69ZnszR ZMOBLzJ1qgriR4nMUvqt7RyCikZuGSfjxECpvMTF/R/org0GWJ2EXQJHJn6RD/P/yLlBTr U1q2T42WPCaOn/d33ynZG+j6kOeYJHr4kd+FVX6tPlXfgQC0iLPhP7JFQmYzBOq0DNxnpM j5jvPUOHlgdyKdSGLsOMmiajaMDZaN4jLZDrDKmfkz8uBrXkmHknqfe8g9ah3vA9zk4YSY MBt7oVGiLygogNu8DkL/Auf+KTzUZ/iZJ8KB9/FHFkGCh3x/R2GhU85D5d4w X-ME-Proxy: Feedback-ID: i51fe4b43:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 18 Nov 2026 18:44:57 -0500 (EST) From: FUJITA Tomonori To: corbet@lwn.net, ojeda@kernel.org Cc: a.hindborg@kernel.org, acourbot@nvidia.com, aliceryhl@google.com, bjorn3_gh@protonmail.com, boqun@kernel.org, dakr@kernel.org, daniel.almeida@collabora.com, gary@garyguo.net, lossin@kernel.org, rdunlap@infradead.org, skhan@linuxfoundation.org, tamird@kernel.org, tmgross@umich.edu, work@onurozkan.dev, linux-doc@vger.kernel.org, rust-for-linux@vger.kernel.org, FUJITA Tomonori Subject: [PATCH v1] docs: rust: mention #[track_caller] for functions that panic Date: Thu, 19 Nov 2026 08:44:51 +0900 Message-ID: <20261118234452.2621985-1-tomo@flapping.org> X-Mailer: git-send-email 2.43.0 X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: FUJITA Tomonori When a function panics, the panic message shows a line inside the function, not the caller. Adding #[track_caller] makes the message show the caller's location. Add a sentence to the "# Panics" guideline: a function that may panic should also be marked with #[track_caller]. Signed-off-by: FUJITA Tomonori --- Documentation/rust/coding-guidelines.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Documentation/rust/coding-guidelines.rst b/Documentation/rust/coding-guidelines.rst index 3198be3a6d63..c7404ea7ba13 100644 --- a/Documentation/rust/coding-guidelines.rst +++ b/Documentation/rust/coding-guidelines.rst @@ -241,6 +241,10 @@ in the kernel: - While not shown here, if a function may panic, the conditions under which that happens must be described under a ``# Panics`` section. + Such a function should also be marked with ``#[track_caller]``, so that + the panic message shows the location of the caller instead of a line + inside the function. + Please note that panicking should be very rare and used only with a good reason. In almost all cases, a fallible approach should be used, typically returning a ``Result``. base-commit: aebb7274476403040d582c61478df8f4a7bf9cd3 -- 2.43.0