From: Sasha Levin <sashal@kernel.org>
To: corbet@lwn.net, linux-doc@vger.kernel.org, workflows@vger.kernel.org
Cc: sashal@kernel.org, josh@joshtriplett.org, kees@kernel.org,
konstantin@linuxfoundation.org, linux-kernel@vger.kernel.org,
rostedt@goodmis.org
Subject: [PATCH 3/4] agents: add coding style documentation and rules
Date: Sun, 27 Jul 2025 15:58:01 -0400 [thread overview]
Message-ID: <20250727195802.2222764-4-sashal@kernel.org> (raw)
In-Reply-To: <20250727195802.2222764-1-sashal@kernel.org>
Signed-off-by: Sasha Levin <sashal@kernel.org>
---
Documentation/agents/coding-style.rst | 35 +++++++++++++++++++++++++++
Documentation/agents/index.rst | 3 ++-
Documentation/agents/main.rst | 5 ++++
3 files changed, 42 insertions(+), 1 deletion(-)
create mode 100644 Documentation/agents/coding-style.rst
diff --git a/Documentation/agents/coding-style.rst b/Documentation/agents/coding-style.rst
new file mode 100644
index 000000000000..b0332ee91e6c
--- /dev/null
+++ b/Documentation/agents/coding-style.rst
@@ -0,0 +1,35 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+Linux Kernel Coding Style
+==========================
+
+Essential coding style documentation and rules for Linux kernel development.
+
+Coding Style Documentation
+--------------------------
+
+The comprehensive guide to Linux kernel coding style, covering indentation, naming conventions, functions, and more.
+
+See :ref:`Documentation/process/coding-style.rst <codingstyle>`
+
+Programming Language
+--------------------
+
+Information about the C programming language dialect used in the kernel, compiler options, and attributes.
+
+See :ref:`Documentation/process/programming-language.rst <programming_language>`
+
+Explicit Coding Rules
+---------------------
+
+The following rules must be followed when writing kernel code:
+
+**No trailing whitespaces**
+ Never leave whitespace at the end of lines. Git will warn about patches that introduce trailing whitespace.
+
+**80 character line limit**
+ The preferred limit on the length of a single line is 80 columns. Statements longer than 80 columns should be broken into sensible chunks, unless exceeding 80 columns significantly increases readability and does not hide information.
+
+**8 character tabs for indents**
+ Tabs are 8 characters, and thus indentations are also 8 characters. The kernel uses tabs for indentation, never spaces. This makes code structure clear and warns when nesting becomes too deep.
\ No newline at end of file
diff --git a/Documentation/agents/index.rst b/Documentation/agents/index.rst
index 2737ab62efa0..354af3f025e5 100644
--- a/Documentation/agents/index.rst
+++ b/Documentation/agents/index.rst
@@ -8,4 +8,5 @@ Agents
:maxdepth: 1
main
- core
\ No newline at end of file
+ core
+ coding-style
\ No newline at end of file
diff --git a/Documentation/agents/main.rst b/Documentation/agents/main.rst
index 34f13d0b975a..8e0463794b76 100644
--- a/Documentation/agents/main.rst
+++ b/Documentation/agents/main.rst
@@ -10,3 +10,8 @@ Core Development Process
------------------------
For essential kernel development documentation, see :doc:`core`
+
+Coding Style
+------------
+
+For coding style guidelines and rules, see :doc:`coding-style`
--
2.39.5
next prev parent reply other threads:[~2025-07-27 19:58 UTC|newest]
Thread overview: 101+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-27 19:57 [PATCH 0/4] Add agent coding assistant configuration to Linux kernel Sasha Levin
2025-07-27 19:57 ` [PATCH 1/4] agents: add unified agent coding assistant configuration Sasha Levin
2025-07-28 2:37 ` Kees Cook
2025-07-28 4:43 ` Sasha Levin
2025-07-28 5:16 ` Kees Cook
2025-07-28 5:39 ` Sasha Levin
2025-07-30 22:06 ` Kevin Hilman
2025-07-30 23:47 ` Sasha Levin
2025-08-01 20:53 ` Rob Herring
2025-08-08 18:07 ` Kevin Hilman
2025-07-27 19:58 ` [PATCH 2/4] agents: add core development references Sasha Levin
2025-07-28 2:39 ` Kees Cook
2025-07-28 5:00 ` Sasha Levin
2025-07-28 5:10 ` Kees Cook
2025-07-28 5:59 ` Sasha Levin
2025-07-28 6:18 ` Kees Cook
2025-07-28 12:35 ` Sasha Levin
2025-07-30 16:25 ` Sasha Levin
2025-07-30 17:35 ` Al Viro
2025-07-30 18:29 ` Sasha Levin
2025-07-30 18:18 ` Matthew Wilcox
2025-07-30 18:41 ` Sasha Levin
2025-07-28 4:24 ` Greg KH
2025-07-28 4:52 ` Sasha Levin
2025-07-28 5:02 ` Kees Cook
2025-07-27 19:58 ` Sasha Levin [this message]
2025-07-28 2:40 ` [PATCH 3/4] agents: add coding style documentation and rules Kees Cook
2025-07-28 5:10 ` Sasha Levin
2025-07-28 5:21 ` Kees Cook
2025-07-28 6:03 ` Sasha Levin
2025-07-30 9:31 ` Krzysztof Kozlowski
2025-07-30 14:48 ` Jakub Kicinski
2025-07-30 15:10 ` Steven Rostedt
2025-07-27 19:58 ` [PATCH 4/4] agents: add legal requirements and agent attribution guidelines Sasha Levin
2025-07-28 2:43 ` Kees Cook
2025-08-05 22:08 ` Jeff Johnson
2025-08-05 23:11 ` Laurent Pinchart
2025-08-05 23:33 ` Sasha Levin
2025-08-06 14:12 ` Konstantin Ryabitsev
2025-08-06 21:53 ` Sasha Levin
2025-07-28 7:58 ` [PATCH 0/4] Add agent coding assistant configuration to Linux kernel Vlastimil Babka
2025-07-28 9:27 ` David Hildenbrand
2025-07-28 10:37 ` Greg KH
2025-07-28 10:47 ` David Hildenbrand
2025-07-28 13:05 ` Sasha Levin
2025-08-04 9:23 ` Michal Hocko
2025-08-04 9:41 ` Michal Hocko
2025-08-04 13:25 ` Sasha Levin
2025-08-04 22:03 ` Jiri Kosina
2025-08-04 22:14 ` Steven Rostedt
2025-08-04 22:30 ` Jiri Kosina
2025-08-04 22:53 ` dan.j.williams
2025-08-04 23:30 ` Sasha Levin
2025-08-04 23:39 ` Laurent Pinchart
2025-08-05 13:29 ` Steven Rostedt
2025-07-28 11:57 ` Sasha Levin
2025-07-28 8:42 ` Lorenzo Stoakes
2025-07-28 10:35 ` Greg KH
2025-07-28 10:52 ` Lorenzo Stoakes
2025-07-28 12:45 ` Sasha Levin
2025-07-28 13:13 ` Lorenzo Stoakes
2025-07-28 13:23 ` Sasha Levin
2025-07-28 13:28 ` Lorenzo Stoakes
2025-07-30 15:27 ` Steven Rostedt
2025-07-30 15:34 ` Lorenzo Stoakes
2025-07-30 16:18 ` Steven Rostedt
2025-07-30 16:33 ` Mauro Carvalho Chehab
2025-07-30 16:36 ` Sasha Levin
2025-07-30 16:59 ` Lorenzo Stoakes
2025-07-30 17:12 ` Sasha Levin
2025-07-30 17:23 ` Lorenzo Stoakes
2025-07-30 17:32 ` Steven Rostedt
2025-07-30 18:03 ` Sasha Levin
2025-07-30 18:18 ` Lorenzo Stoakes
2025-07-30 18:04 ` Lorenzo Stoakes
2025-07-30 19:16 ` Mark Brown
2025-07-30 17:25 ` Steven Rostedt
2025-07-30 17:34 ` Mark Brown
2025-07-30 17:36 ` Kees Cook
2025-08-04 10:20 ` Jiri Kosina
2025-07-30 17:05 ` Steven Rostedt
2025-07-30 17:46 ` Sasha Levin
2025-07-30 17:59 ` Al Viro
2025-07-30 18:10 ` Sasha Levin
2025-07-30 18:24 ` Lorenzo Stoakes
2025-07-30 18:59 ` Sasha Levin
2025-07-30 19:10 ` Theodore Ts'o
2025-07-30 19:40 ` Steven Rostedt
2025-07-30 19:51 ` Al Viro
2025-07-30 19:27 ` Steven Rostedt
2025-07-31 0:02 ` Mauro Carvalho Chehab
2025-07-30 16:40 ` Dr. David Alan Gilbert
2025-07-30 17:10 ` Lorenzo Stoakes
2025-07-30 17:20 ` Steven Rostedt
2025-07-30 17:33 ` Lorenzo Stoakes
2025-07-30 17:12 ` Steven Rostedt
2025-07-30 17:39 ` Dr. David Alan Gilbert
2025-07-30 17:51 ` Kees Cook
2025-07-30 16:58 ` Lorenzo Stoakes
2025-07-28 10:56 ` Laurent Pinchart
2025-08-12 18:13 ` Nicolas Frattaroli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250727195802.2222764-4-sashal@kernel.org \
--to=sashal@kernel.org \
--cc=corbet@lwn.net \
--cc=josh@joshtriplett.org \
--cc=kees@kernel.org \
--cc=konstantin@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).