Merge tag 'docs-6.0' of git://git.lwn.net/linux
[linux-2.6-microblaze.git] / Documentation / process / index.rst
1 .. raw:: latex
2
3         \renewcommand\thesection*
4         \renewcommand\thesubsection*
5
6 .. _process_index:
7
8 Working with the kernel development community
9 =============================================
10
11 So you want to be a Linux kernel developer?  Welcome!  While there is a lot
12 to be learned about the kernel in a technical sense, it is also important
13 to learn about how our community works.  Reading these documents will make
14 it much easier for you to get your changes merged with a minimum of
15 trouble.
16
17 Below are the essential guides that every developer should read.
18
19 .. toctree::
20    :maxdepth: 1
21
22    license-rules
23    howto
24    code-of-conduct
25    code-of-conduct-interpretation
26    development-process
27    submitting-patches
28    handling-regressions
29    programming-language
30    coding-style
31    maintainer-handbooks
32    maintainer-pgp-guide
33    email-clients
34    kernel-enforcement-statement
35    kernel-driver-statement
36
37 Other guides to the community that are of interest to most developers are:
38
39 .. toctree::
40    :maxdepth: 1
41
42    changes
43    stable-api-nonsense
44    management-style
45    stable-kernel-rules
46    submit-checklist
47    kernel-docs
48    deprecated
49    embargoed-hardware-issues
50    maintainers
51    researcher-guidelines
52
53 These are some overall technical guides that have been put here for now for
54 lack of a better place.
55
56 .. toctree::
57    :maxdepth: 1
58
59    applying-patches
60    adding-syscalls
61    magic-number
62    volatile-considered-harmful
63    botching-up-ioctls
64    clang-format
65    ../riscv/patch-acceptance
66    ../core-api/unaligned-memory-access
67
68 .. only::  subproject and html
69
70    Indices
71    =======
72
73    * :ref:`genindex`