| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 1 | .. raw:: latex |
| 2 | |
| 3 | \renewcommand\thesection* |
| 4 | \renewcommand\thesubsection* |
| 5 | |
| Daniel Vetter | eadf71c | 2017-03-21 16:52:28 +0100 | [diff] [blame] | 6 | .. _process_index: |
| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 7 | |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 8 | Working with the kernel development community |
| 9 | ============================================= |
| Mauro Carvalho Chehab | f0ddda3 | 2016-09-19 08:07:38 -0300 | [diff] [blame] | 10 | |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 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. |
| Mauro Carvalho Chehab | f0ddda3 | 2016-09-19 08:07:38 -0300 | [diff] [blame] | 18 | |
| 19 | .. toctree:: |
| Jonathan Corbet | be46124 | 2016-10-26 16:41:05 -0600 | [diff] [blame] | 20 | :maxdepth: 1 |
| Mauro Carvalho Chehab | f0ddda3 | 2016-09-19 08:07:38 -0300 | [diff] [blame] | 21 | |
| Markus Heiser | 9799445 | 2018-08-14 13:43:12 +0200 | [diff] [blame] | 22 | license-rules |
| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 23 | howto |
| Greg Kroah-Hartman | 8a104f8 | 2018-09-15 20:26:44 +0200 | [diff] [blame] | 24 | code-of-conduct |
| Greg Kroah-Hartman | 79dbeed | 2018-10-14 16:16:47 +0200 | [diff] [blame] | 25 | code-of-conduct-interpretation |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 26 | development-process |
| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 27 | submitting-patches |
| Miguel Ojeda | 303d22c | 2018-09-03 18:32:11 +0200 | [diff] [blame] | 28 | programming-language |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 29 | coding-style |
| Konstantin Ryabitsev | b72dde3 | 2018-02-01 09:42:33 -0500 | [diff] [blame] | 30 | maintainer-pgp-guide |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 31 | email-clients |
| Greg Kroah-Hartman | 9ed9512 | 2017-10-04 16:17:55 +0200 | [diff] [blame] | 32 | kernel-enforcement-statement |
| Greg Kroah-Hartman | 1327778 | 2017-10-06 11:10:38 +0200 | [diff] [blame] | 33 | kernel-driver-statement |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 34 | |
| Daniel W. S. Almeida | b666758 | 2020-07-18 13:50:59 -0300 | [diff] [blame] | 35 | Other guides to the community that are of interest to most developers are: |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 36 | |
| 37 | .. toctree:: |
| Jonathan Corbet | be46124 | 2016-10-26 16:41:05 -0600 | [diff] [blame] | 38 | :maxdepth: 1 |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 39 | |
| 40 | changes |
| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 41 | submitting-drivers |
| 42 | stable-api-nonsense |
| 43 | management-style |
| 44 | stable-kernel-rules |
| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 45 | submit-checklist |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 46 | kernel-docs |
| Kees Cook | 84253c8 | 2018-10-17 16:45:32 -0700 | [diff] [blame] | 47 | deprecated |
| Thomas Gleixner | ddaedbb | 2019-08-15 23:25:05 +0200 | [diff] [blame] | 48 | embargoed-hardware-issues |
| Kees Cook | aa20485 | 2019-10-01 11:25:32 -0700 | [diff] [blame] | 49 | maintainers |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 50 | |
| 51 | These are some overall technical guides that have been put here for now for |
| 52 | lack of a better place. |
| 53 | |
| 54 | .. toctree:: |
| Jonathan Corbet | be46124 | 2016-10-26 16:41:05 -0600 | [diff] [blame] | 55 | :maxdepth: 1 |
| Jonathan Corbet | 9b4ebd9 | 2016-10-26 16:34:09 -0600 | [diff] [blame] | 56 | |
| 57 | applying-patches |
| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 58 | adding-syscalls |
| 59 | magic-number |
| 60 | volatile-considered-harmful |
| Jonathan Corbet | 5ecd0a0 | 2019-10-03 12:58:42 -0600 | [diff] [blame] | 61 | botching-up-ioctls |
| Mauro Carvalho Chehab | 2d93404 | 2018-05-07 06:35:39 -0300 | [diff] [blame] | 62 | clang-format |
| Paul Walmsley | 0e194d9 | 2019-11-22 18:33:28 -0800 | [diff] [blame] | 63 | ../riscv/patch-acceptance |
| Daniel W. S. Almeida | b666758 | 2020-07-18 13:50:59 -0300 | [diff] [blame] | 64 | ../core-api/unaligned-memory-access |
| Mauro Carvalho Chehab | 186128f | 2016-09-21 08:40:21 -0300 | [diff] [blame] | 65 | |
| Markus Heiser | 6f2ec3a | 2016-10-26 08:23:16 +0200 | [diff] [blame] | 66 | .. only:: subproject and html |
| 67 | |
| 68 | Indices |
| 69 | ======= |
| 70 | |
| 71 | * :ref:`genindex` |