Skip to content

Commit fb0e0ff

Browse files
tonyfischettiJonathan Corbet
authored andcommitted
Documentation: bring process docs up to date
The guide to the kernel dev process documentation, for example, contains references to older kernels and their timelines. In addition, one of the "long term support kernels" listed have since reached EOL, and a new one has been named. This patch brings information/tables up to date. Additionally, some very trivial grammatical errors, unclear sentences, and potentially unsavory diction have been edited. Signed-off-by: Tony Fischetti <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent dff2c2e commit fb0e0ff

File tree

3 files changed

+73
-70
lines changed

3 files changed

+73
-70
lines changed

Documentation/process/2.Process.rst

Lines changed: 55 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ major kernel release happening every two or three months. The recent
1818
release history looks like this:
1919

2020
====== =================
21-
4.11 April 30, 2017
22-
4.12 July 2, 2017
23-
4.13 September 3, 2017
24-
4.14 November 12, 2017
25-
4.15 January 28, 2018
26-
4.16 April 1, 2018
21+
5.0 March 3, 2019
22+
5.1 May 5, 2019
23+
5.2 July 7, 2019
24+
5.3 September 15, 2019
25+
5.4 November 24, 2019
26+
5.5 January 6, 2020
2727
====== =================
2828

29-
Every 4.x release is a major kernel release with new features, internal
30-
API changes, and more. A typical 4.x release contain about 13,000
31-
changesets with changes to several hundred thousand lines of code. 4.x is
32-
thus the leading edge of Linux kernel development; the kernel uses a
29+
Every 5.x release is a major kernel release with new features, internal
30+
API changes, and more. A typical release can contain about 13,000
31+
changesets with changes to several hundred thousand lines of code. 5.x is
32+
the leading edge of Linux kernel development; the kernel uses a
3333
rolling development model which is continually integrating major changes.
3434

3535
A relatively straightforward discipline is followed with regard to the
@@ -48,9 +48,9 @@ detail later on).
4848

4949
The merge window lasts for approximately two weeks. At the end of this
5050
time, Linus Torvalds will declare that the window is closed and release the
51-
first of the "rc" kernels. For the kernel which is destined to be 2.6.40,
51+
first of the "rc" kernels. For the kernel which is destined to be 5.6,
5252
for example, the release which happens at the end of the merge window will
53-
be called 2.6.40-rc1. The -rc1 release is the signal that the time to
53+
be called 5.6-rc1. The -rc1 release is the signal that the time to
5454
merge new features has passed, and that the time to stabilize the next
5555
kernel has begun.
5656

@@ -67,22 +67,23 @@ add at any time).
6767
As fixes make their way into the mainline, the patch rate will slow over
6868
time. Linus releases new -rc kernels about once a week; a normal series
6969
will get up to somewhere between -rc6 and -rc9 before the kernel is
70-
considered to be sufficiently stable and the final 2.6.x release is made.
70+
considered to be sufficiently stable and the final release is made.
7171
At that point the whole process starts over again.
7272

73-
As an example, here is how the 4.16 development cycle went (all dates in
74-
2018):
73+
As an example, here is how the 5.4 development cycle went (all dates in
74+
2019):
7575

7676
============== ===============================
77-
January 28 4.15 stable release
78-
February 11 4.16-rc1, merge window closes
79-
February 18 4.16-rc2
80-
February 25 4.16-rc3
81-
March 4 4.16-rc4
82-
March 11 4.16-rc5
83-
March 18 4.16-rc6
84-
March 25 4.16-rc7
85-
April 1 4.16 stable release
77+
September 15 5.3 stable release
78+
September 30 5.4-rc1, merge window closes
79+
October 6 5.4-rc2
80+
October 13 5.4-rc3
81+
October 20 5.4-rc4
82+
October 27 5.4-rc5
83+
November 3 5.4-rc6
84+
November 10 5.4-rc7
85+
November 17 5.4-rc8
86+
November 24 5.4 stable release
8687
============== ===============================
8788

8889
How do the developers decide when to close the development cycle and create
@@ -98,43 +99,44 @@ release is made. In the real world, this kind of perfection is hard to
9899
achieve; there are just too many variables in a project of this size.
99100
There comes a point where delaying the final release just makes the problem
100101
worse; the pile of changes waiting for the next merge window will grow
101-
larger, creating even more regressions the next time around. So most 4.x
102+
larger, creating even more regressions the next time around. So most 5.x
102103
kernels go out with a handful of known regressions though, hopefully, none
103104
of them are serious.
104105

105106
Once a stable release is made, its ongoing maintenance is passed off to the
106-
"stable team," currently consisting of Greg Kroah-Hartman. The stable team
107-
will release occasional updates to the stable release using the 4.x.y
108-
numbering scheme. To be considered for an update release, a patch must (1)
109-
fix a significant bug, and (2) already be merged into the mainline for the
110-
next development kernel. Kernels will typically receive stable updates for
111-
a little more than one development cycle past their initial release. So,
112-
for example, the 4.13 kernel's history looked like:
107+
"stable team," currently Greg Kroah-Hartman. The stable team will release
108+
occasional updates to the stable release using the 5.x.y numbering scheme.
109+
To be considered for an update release, a patch must (1) fix a significant
110+
bug, and (2) already be merged into the mainline for the next development
111+
kernel. Kernels will typically receive stable updates for a little more
112+
than one development cycle past their initial release. So, for example, the
113+
5.2 kernel's history looked like this (all dates in 2019):
113114

114115
============== ===============================
115-
September 3 4.13 stable release
116-
September 13 4.13.1
117-
September 20 4.13.2
118-
September 27 4.13.3
119-
October 5 4.13.4
120-
October 12 4.13.5
116+
September 15 5.2 stable release
117+
July 14 5.2.1
118+
July 21 5.2.2
119+
July 26 5.2.3
120+
July 28 5.2.4
121+
July 31 5.2.5
121122
... ...
122-
November 24 4.13.16
123+
October 11 5.2.21
123124
============== ===============================
124125

125-
4.13.16 was the final stable update of the 4.13 release.
126+
5.2.21 was the final stable update of the 5.2 release.
126127

127128
Some kernels are designated "long term" kernels; they will receive support
128129
for a longer period. As of this writing, the current long term kernels
129130
and their maintainers are:
130131

131-
====== ====================== ==============================
132-
3.16 Ben Hutchings (very long-term stable kernel)
133-
4.1 Sasha Levin
134-
4.4 Greg Kroah-Hartman (very long-term stable kernel)
135-
4.9 Greg Kroah-Hartman
136-
4.14 Greg Kroah-Hartman
137-
====== ====================== ==============================
132+
====== ================================ =======================
133+
3.16 Ben Hutchings (very long-term kernel)
134+
4.4 Greg Kroah-Hartman & Sasha Levin (very long-term kernel)
135+
4.9 Greg Kroah-Hartman & Sasha Levin
136+
4.14 Greg Kroah-Hartman & Sasha Levin
137+
4.19 Greg Kroah-Hartman & Sasha Levin
138+
5.4 Greg Kroah-Hartman & Sasha Levin
139+
====== ================================ =======================
138140

139141
The selection of a kernel for long-term support is purely a matter of a
140142
maintainer having the need and the time to maintain that release. There
@@ -215,12 +217,12 @@ How patches get into the Kernel
215217
-------------------------------
216218

217219
There is exactly one person who can merge patches into the mainline kernel
218-
repository: Linus Torvalds. But, of the over 9,500 patches which went
219-
into the 2.6.38 kernel, only 112 (around 1.3%) were directly chosen by Linus
220-
himself. The kernel project has long since grown to a size where no single
221-
developer could possibly inspect and select every patch unassisted. The
222-
way the kernel developers have addressed this growth is through the use of
223-
a lieutenant system built around a chain of trust.
220+
repository: Linus Torvalds. But, for example, of the over 9,500 patches
221+
which went into the 2.6.38 kernel, only 112 (around 1.3%) were directly
222+
chosen by Linus himself. The kernel project has long since grown to a size
223+
where no single developer could possibly inspect and select every patch
224+
unassisted. The way the kernel developers have addressed this growth is
225+
through the use of a lieutenant system built around a chain of trust.
224226

225227
The kernel code base is logically broken down into a set of subsystems:
226228
networking, specific architecture support, memory management, video

Documentation/process/coding-style.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -284,9 +284,9 @@ context lines.
284284
4) Naming
285285
---------
286286

287-
C is a Spartan language, and so should your naming be. Unlike Modula-2
288-
and Pascal programmers, C programmers do not use cute names like
289-
ThisVariableIsATemporaryCounter. A C programmer would call that
287+
C is a Spartan language, and your naming conventions should follow suit.
288+
Unlike Modula-2 and Pascal programmers, C programmers do not use cute
289+
names like ThisVariableIsATemporaryCounter. A C programmer would call that
290290
variable ``tmp``, which is much easier to write, and not the least more
291291
difficult to understand.
292292

@@ -300,9 +300,9 @@ that counts the number of active users, you should call that
300300
``count_active_users()`` or similar, you should **not** call it ``cntusr()``.
301301

302302
Encoding the type of a function into the name (so-called Hungarian
303-
notation) is brain damaged - the compiler knows the types anyway and can
304-
check those, and it only confuses the programmer. No wonder MicroSoft
305-
makes buggy programs.
303+
notation) is asinine - the compiler knows the types anyway and can check
304+
those, and it only confuses the programmer. No wonder Microsoft makes buggy
305+
programs.
306306

307307
LOCAL variable names should be short, and to the point. If you have
308308
some random integer loop counter, it should probably be called ``i``.
@@ -806,9 +806,9 @@ covers RTL which is used frequently with assembly language in the kernel.
806806
----------------------------
807807

808808
Kernel developers like to be seen as literate. Do mind the spelling
809-
of kernel messages to make a good impression. Do not use crippled
810-
words like ``dont``; use ``do not`` or ``don't`` instead. Make the messages
811-
concise, clear, and unambiguous.
809+
of kernel messages to make a good impression. Do not use incorrect
810+
contractions like ``dont``; use ``do not`` or ``don't`` instead. Make the
811+
messages concise, clear, and unambiguous.
812812

813813
Kernel messages do not have to be terminated with a period.
814814

Documentation/process/howto.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -243,10 +243,10 @@ branches. These different branches are:
243243
Mainline tree
244244
~~~~~~~~~~~~~
245245

246-
Mainline tree are maintained by Linus Torvalds, and can be found at
246+
The mainline tree is maintained by Linus Torvalds, and can be found at
247247
https://kernel.org or in the repo. Its development process is as follows:
248248

249-
- As soon as a new kernel is released a two weeks window is open,
249+
- As soon as a new kernel is released a two week window is open,
250250
during this period of time maintainers can submit big diffs to
251251
Linus, usually the patches that have already been included in the
252252
linux-next for a few weeks. The preferred way to submit big changes
@@ -281,8 +281,9 @@ Various stable trees with multiple major numbers
281281

282282
Kernels with 3-part versions are -stable kernels. They contain
283283
relatively small and critical fixes for security problems or significant
284-
regressions discovered in a given major mainline release, with the first
285-
2-part of version number are the same correspondingly.
284+
regressions discovered in a given major mainline release. Each release
285+
in a major stable series increments the third part of the version
286+
number, keeping the first two parts the same.
286287

287288
This is the recommended branch for users who want the most recent stable
288289
kernel and are not interested in helping test development/experimental
@@ -359,10 +360,10 @@ Managing bug reports
359360

360361
One of the best ways to put into practice your hacking skills is by fixing
361362
bugs reported by other people. Not only you will help to make the kernel
362-
more stable, you'll learn to fix real world problems and you will improve
363-
your skills, and other developers will be aware of your presence. Fixing
364-
bugs is one of the best ways to get merits among other developers, because
365-
not many people like wasting time fixing other people's bugs.
363+
more stable, but you'll also learn to fix real world problems and you will
364+
improve your skills, and other developers will be aware of your presence.
365+
Fixing bugs is one of the best ways to get merits among other developers,
366+
because not many people like wasting time fixing other people's bugs.
366367

367368
To work in the already reported bug reports, go to https://bugzilla.kernel.org.
368369

0 commit comments

Comments
 (0)