| 1 | .. raw:: latex
|
| 2 |
|
| 3 | \renewcommand\thesection*
|
| 4 | \renewcommand\thesubsection*
|
| 5 |
|
| 6 | .. _process_index:
|
| 7 |
|
| 8 | =============================================
|
| 9 | Working with the kernel development community
|
| 10 | =============================================
|
| 11 |
|
| 12 | So you want to be a Linux kernel developer? Welcome! While there is a lot
|
| 13 | to be learned about the kernel in a technical sense, it is also important
|
| 14 | to learn about how our community works. Reading these documents will make
|
| 15 | it much easier for you to get your changes merged with a minimum of
|
| 16 | trouble.
|
| 17 |
|
| 18 | An introduction to how kernel development works
|
| 19 | -----------------------------------------------
|
| 20 |
|
| 21 | Read these documents first: an understanding of the material here will ease
|
| 22 | your entry into the kernel community.
|
| 23 |
|
| 24 | .. toctree::
|
| 25 | :maxdepth: 1
|
| 26 |
|
| 27 | howto
|
| 28 | development-process
|
| 29 | submitting-patches
|
| 30 | submit-checklist
|
| 31 |
|
| 32 | Tools and technical guides for kernel developers
|
| 33 | ------------------------------------------------
|
| 34 |
|
| 35 | This is a collection of material that kernel developers should be familiar
|
| 36 | with.
|
| 37 |
|
| 38 | .. toctree::
|
| 39 | :maxdepth: 1
|
| 40 |
|
| 41 | changes
|
| 42 | programming-language
|
| 43 | coding-style
|
| 44 | maintainer-pgp-guide
|
| 45 | email-clients
|
| 46 | applying-patches
|
| 47 | backporting
|
| 48 | adding-syscalls
|
| 49 | volatile-considered-harmful
|
| 50 | botching-up-ioctls
|
| 51 |
|
| 52 | Policy guides and developer statements
|
| 53 | --------------------------------------
|
| 54 |
|
| 55 | These are the rules that we try to live by in the kernel community (and
|
| 56 | beyond).
|
| 57 |
|
| 58 | .. toctree::
|
| 59 | :maxdepth: 1
|
| 60 |
|
| 61 | license-rules
|
| 62 | code-of-conduct
|
| 63 | code-of-conduct-interpretation
|
| 64 | contribution-maturity-model
|
| 65 | kernel-enforcement-statement
|
| 66 | kernel-driver-statement
|
| 67 | stable-api-nonsense
|
| 68 | stable-kernel-rules
|
| 69 | management-style
|
| 70 | researcher-guidelines
|
| 71 | generated-content
|
| 72 | coding-assistants
|
| 73 | conclave
|
| 74 |
|
| 75 | Dealing with bugs
|
| 76 | -----------------
|
| 77 |
|
| 78 | Bugs are a fact of life; it is important that we handle them properly. The
|
| 79 | documents below provide general advice about debugging and describe our
|
| 80 | policies around the handling of a couple of special classes of bugs:
|
| 81 | regressions and security problems.
|
| 82 |
|
| 83 | .. toctree::
|
| 84 | :maxdepth: 1
|
| 85 |
|
| 86 | debugging/index
|
| 87 | handling-regressions
|
| 88 | security-bugs
|
| 89 | threat-model
|
| 90 | cve
|
| 91 | embargoed-hardware-issues
|
| 92 |
|
| 93 | Maintainer information
|
| 94 | ----------------------
|
| 95 |
|
| 96 | How to find the people who will accept your patches.
|
| 97 |
|
| 98 | .. toctree::
|
| 99 | :maxdepth: 1
|
| 100 |
|
| 101 | maintainer-handbooks
|
| 102 | maintainers
|
| 103 |
|
| 104 | Other material
|
| 105 | --------------
|
| 106 |
|
| 107 | Here are some other guides to the community that are of interest to most
|
| 108 | developers:
|
| 109 |
|
| 110 | .. toctree::
|
| 111 | :maxdepth: 1
|
| 112 |
|
| 113 | kernel-docs
|
| 114 | deprecated
|