From nobody Sat Feb 7 08:27:07 2026 Received: from mout-y-209.mailbox.org (mout-y-209.mailbox.org [91.198.250.237]) (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 9EA6E1C3F2F; Fri, 16 Aug 2024 20:03:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=91.198.250.237 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723838641; cv=none; b=nmipzsrYVZ00Ivac4h9o3L49B73jFNxod0LFezYGIeKmOZDfdstfYci7zSJ9VHfGnAj9LrLWwDbGHW1+kF+AID+E5crdUU5q54JU1n8JyAiyr+NHjqd3AVvSGYGcqK9/a1YFeftqPrwTmcZBgm+iUJxqHXLSloZ3S8fMII9+h7Y= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723838641; c=relaxed/simple; bh=EfY6RyzPijR+8o0uiBmOE9Km3u7n4FAWqGLHE1nmejU=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=covnUdqiE3ao2nOgm1WO/8+JChnDOrsTx0WTgY7X6gSbsWJNVYKCvy9D5pVSrSZLS1wQHd25xaQbtVlXJCWIJuC6uDhmFLeZw7ydCEm+NkYkpVG/74Haq1SmxIT0K5MbHdoKEYxmA+JYMLf6gN7OJDghi71kLoxQRqpvk7EeyZs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=woltmann.art; spf=fail smtp.mailfrom=woltmann.art; dkim=pass (2048-bit key) header.d=woltmann.art header.i=@woltmann.art header.b=bvUlWJAG; arc=none smtp.client-ip=91.198.250.237 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=woltmann.art Authentication-Results: smtp.subspace.kernel.org; spf=fail smtp.mailfrom=woltmann.art Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=woltmann.art header.i=@woltmann.art header.b="bvUlWJAG" Received: from smtp1.mailbox.org (smtp1.mailbox.org [10.196.197.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-y-209.mailbox.org (Postfix) with ESMTPS id 4WltGx6yLhz9wHW; Fri, 16 Aug 2024 22:03:53 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=woltmann.art; s=MBO0001; t=1723838634; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=AyxiDhwXGVsv4189wxQK+GGVD/RgUw6fevyZy61wors=; b=bvUlWJAGI28MaTEumJg4BxxqZAgk3Z4iXbQonAUCV67RoAVk/3PVFGnPfcZ3BXYcU3BYU6 i96Su/nSC1g44wOOhKnjQa349oK52J0IkLY8pf84kFft9yfiFo7a9e0v57QrGeRXKL8UnO U9dJvEujLa3DSYIXhCTlIfvoNyj+LiJMbRUWNAEeNioUCoqxCsR+beiOlftz+LOqpz97AY HOyZR8jnffCp/gQbIwPlc6oEgifOieeYXkB94VclLe4zZo3CQqLEH/l5fn1Kf6VcGMsCYm nF57AHHxGXTVapAJW1bjfziqv2E9mts1aSQY5qr/LD1OQ6PFUTkLi1M9MNMHwQ== From: Vincent Woltmann To: rust-for-linux@vger.kernel.org Cc: Vincent Woltmann , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Jonathan Corbet , Wei Liu , Yuki Okushi , linux-doc@vger.kernel.org (open list:DOCUMENTATION), linux-kernel@vger.kernel.org (open list) Subject: [PATCH v2] rust: Remove erronous blockquote in coding guidelines Date: Fri, 16 Aug 2024 20:01:42 +0000 Message-ID: <20240816200339.2495875-1-vincent@woltmann.art> 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" An unordered list in coding-guidelines.rst was indented, producing a blockquote around it and making it look more indented than expected. Remove the indentation to only output an unordered list. Reported-by: Miguel Ojeda Closes: https://github.com/Rust-for-Linux/linux/issues/1063 Fixes: d07479b211b7 ("docs: add Rust documentation") Signed-off-by: Vincent Woltmann --- Changes since v1: - Readded the last paragraph to the list, which was removed because I deleted too much indentation in v1 Documentation/rust/coding-guidelines.rst | 38 ++++++++++++------------ 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/Documentation/rust/coding-guidelines.rst b/Documentation/rust/= coding-guidelines.rst index 05542840b16c..329b070a1d47 100644 --- a/Documentation/rust/coding-guidelines.rst +++ b/Documentation/rust/coding-guidelines.rst @@ -145,32 +145,32 @@ This is how a well-documented Rust function may look = like: This example showcases a few ``rustdoc`` features and some conventions fol= lowed in the kernel: =20 - - The first paragraph must be a single sentence briefly describing what - the documented item does. Further explanations must go in extra paragr= aphs. +- The first paragraph must be a single sentence briefly describing what + the documented item does. Further explanations must go in extra paragrap= hs. =20 - - Unsafe functions must document their safety preconditions under - a ``# Safety`` section. +- Unsafe functions must document their safety preconditions under + a ``# Safety`` section. =20 - - While not shown here, if a function may panic, the conditions under wh= ich - that happens must be described under a ``# Panics`` section. +- While not shown here, if a function may panic, the conditions under which + that happens must be described under a ``# Panics`` section. =20 - Please note that panicking should be very rare and used only with a go= od - reason. In almost all cases, a fallible approach should be used, typic= ally - returning a ``Result``. + 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, typical= ly + returning a ``Result``. =20 - - If providing examples of usage would help readers, they must be writte= n in - a section called ``# Examples``. +- If providing examples of usage would help readers, they must be written = in + a section called ``# Examples``. =20 - - Rust items (functions, types, constants...) must be linked appropriate= ly - (``rustdoc`` will create a link automatically). +- Rust items (functions, types, constants...) must be linked appropriately + (``rustdoc`` will create a link automatically). =20 - - Any ``unsafe`` block must be preceded by a ``// SAFETY:`` comment - describing why the code inside is sound. +- Any ``unsafe`` block must be preceded by a ``// SAFETY:`` comment + describing why the code inside is sound. =20 - While sometimes the reason might look trivial and therefore unneeded, - writing these comments is not just a good way of documenting what has = been - taken into account, but most importantly, it provides a way to know th= at - there are no *extra* implicit constraints. + While sometimes the reason might look trivial and therefore unneeded, + writing these comments is not just a good way of documenting what has be= en + taken into account, but most importantly, it provides a way to know that + there are no *extra* implicit constraints. =20 To learn more about how to write documentation for Rust and extra features, please take a look at the ``rustdoc`` book at: --=20 2.41.0