summaryrefslogtreecommitdiff
path: root/Documentation/process/index.rst
blob: 3587dae4d0ef82ecdb01b139de45733bb6f7a01d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
.. raw:: latex

	\renewcommand\thesection*
	\renewcommand\thesubsection*

.. _process_index:

Working with the kernel development community
=============================================

So you want to be a Linux kernel developer?  Welcome!  While there is a lot
to be learned about the kernel in a technical sense, it is also important
to learn about how our community works.  Reading these documents will make
it much easier for you to get your changes merged with a minimum of
trouble.

Below are the essential guides that every developer should read.

.. toctree::
   :maxdepth: 1

   license-rules
   howto
   code-of-conduct
   code-of-conduct-interpretation
   development-process
   submitting-patches
   handling-regressions
   programming-language
   coding-style
   maintainer-handbooks
   maintainer-pgp-guide
   email-clients
   kernel-enforcement-statement
   kernel-driver-statement

Other guides to the community that are of interest to most developers are:

.. toctree::
   :maxdepth: 1

   changes
   submitting-drivers
   stable-api-nonsense
   management-style
   stable-kernel-rules
   submit-checklist
   kernel-docs
   deprecated
   embargoed-hardware-issues
   maintainers
   researcher-guidelines

These are some overall technical guides that have been put here for now for
lack of a better place.

.. toctree::
   :maxdepth: 1

   applying-patches
   adding-syscalls
   magic-number
   volatile-considered-harmful
   botching-up-ioctls
   clang-format
   ../riscv/patch-acceptance
   ../core-api/unaligned-memory-access

.. only::  subproject and html

   Indices
   =======

   * :ref:`genindex`