| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 1 | .. The Linux Kernel documentation master file, created by |
| 2 | sphinx-quickstart on Fri Feb 12 13:51:46 2016. |
| 3 | You can adapt this file completely to your liking, but it should at least |
| 4 | contain the root `toctree` directive. |
| 5 | |
| Konstantin Ryabitsev | 61ca5fd | 2017-06-06 16:50:04 -0400 | [diff] [blame] | 6 | The Linux Kernel documentation |
| 7 | ============================== |
| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 8 | |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame] | 9 | This is the top level of the kernel's documentation tree. Kernel |
| 10 | documentation, like the kernel itself, is very much a work in progress; |
| 11 | that is especially true as we work to integrate our many scattered |
| 12 | documents into a coherent whole. Please note that improvements to the |
| 13 | documentation are welcome; join the linux-doc list at vger.kernel.org if |
| 14 | you want to help out. |
| 15 | |
| 16 | User-oriented documentation |
| 17 | --------------------------- |
| 18 | |
| 19 | The following manuals are written for *users* of the kernel — those who are |
| 20 | trying to get it to work optimally on a given system. |
| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 21 | |
| 22 | .. toctree:: |
| 23 | :maxdepth: 2 |
| 24 | |
| Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 25 | admin-guide/index |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame] | 26 | |
| Jonathan Corbet | 1d596de | 2017-04-02 14:58:01 -0600 | [diff] [blame] | 27 | Application-developer documentation |
| 28 | ----------------------------------- |
| 29 | |
| 30 | The user-space API manual gathers together documents describing aspects of |
| 31 | the kernel interface as seen by application developers. |
| 32 | |
| 33 | .. toctree:: |
| 34 | :maxdepth: 2 |
| 35 | |
| 36 | userspace-api/index |
| 37 | |
| 38 | |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame] | 39 | Introduction to kernel development |
| 40 | ---------------------------------- |
| 41 | |
| 42 | These manuals contain overall information about how to develop the kernel. |
| 43 | The kernel community is quite large, with thousands of developers |
| 44 | contributing over the course of a year. As with any large community, |
| 45 | knowing how things are done will make the process of getting your changes |
| 46 | merged much easier. |
| 47 | |
| 48 | .. toctree:: |
| 49 | :maxdepth: 2 |
| 50 | |
| Mauro Carvalho Chehab | 0e4f07a | 2016-10-18 09:05:32 -0200 | [diff] [blame] | 51 | process/index |
| Markus Heiser | c289312 | 2016-10-26 08:23:14 +0200 | [diff] [blame] | 52 | dev-tools/index |
| Mauro Carvalho Chehab | 1dc4bbf | 2016-11-17 08:32:33 -0200 | [diff] [blame] | 53 | doc-guide/index |
| Mauro Carvalho Chehab | c4fcd7c | 2017-05-11 08:03:27 -0300 | [diff] [blame] | 54 | kernel-hacking/index |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame] | 55 | |
| 56 | Kernel API documentation |
| 57 | ------------------------ |
| 58 | |
| 59 | These books get into the details of how specific kernel subsystems work |
| 60 | from the point of view of a kernel developer. Much of the information here |
| 61 | is taken directly from the kernel source, with supplemental material added |
| 62 | as needed (or at least as we managed to add it — probably *not* all that is |
| Andy Deng | 2069889 | 2017-01-25 12:14:33 +0800 | [diff] [blame] | 63 | needed). |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame] | 64 | |
| 65 | .. toctree:: |
| 66 | :maxdepth: 2 |
| 67 | |
| Jonathan Corbet | dcec3c8 | 2016-08-20 13:17:32 -0600 | [diff] [blame] | 68 | driver-api/index |
| Silvio Fricke | 24755a5 | 2016-10-28 10:14:10 +0200 | [diff] [blame] | 69 | core-api/index |
| Markus Heiser | b32feba | 2016-08-13 16:12:43 +0200 | [diff] [blame] | 70 | media/index |
| Mauro Carvalho Chehab | 05e0f3b | 2017-05-12 09:14:02 -0300 | [diff] [blame] | 71 | networking/index |
| Mauro Carvalho Chehab | aeb899a | 2017-04-11 07:01:19 -0300 | [diff] [blame] | 72 | input/index |
| Jani Nikula | cb597fc | 2016-06-21 14:48:57 +0300 | [diff] [blame] | 73 | gpu/index |
| Jarkko Sakkinen | 799a545 | 2016-11-03 17:57:52 -0600 | [diff] [blame] | 74 | security/index |
| Takashi Iwai | 8551914 | 2016-11-02 21:30:39 +0100 | [diff] [blame] | 75 | sound/index |
| Stephan Mueller | 3b72c81 | 2016-10-21 04:54:22 +0200 | [diff] [blame] | 76 | crypto/index |
| Mauro Carvalho Chehab | 90f9f11 | 2017-05-12 06:50:22 -0300 | [diff] [blame] | 77 | filesystems/index |
| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 78 | |
| Mauro Carvalho Chehab | bffac83 | 2017-05-13 07:50:43 -0300 | [diff] [blame] | 79 | Architecture-specific documentation |
| 80 | ----------------------------------- |
| 81 | |
| 82 | These books provide programming details about architecture-specific |
| 83 | implementation. |
| 84 | |
| 85 | .. toctree:: |
| 86 | :maxdepth: 2 |
| 87 | |
| 88 | sh/index |
| 89 | |
| SeongJae Park | ba42c57 | 2016-11-08 21:26:09 +0900 | [diff] [blame] | 90 | Korean translations |
| 91 | ------------------- |
| 92 | |
| 93 | .. toctree:: |
| 94 | :maxdepth: 1 |
| 95 | |
| 96 | translations/ko_KR/index |
| 97 | |
| Andy Deng | 2069889 | 2017-01-25 12:14:33 +0800 | [diff] [blame] | 98 | Chinese translations |
| 99 | -------------------- |
| 100 | |
| 101 | .. toctree:: |
| 102 | :maxdepth: 1 |
| 103 | |
| 104 | translations/zh_CN/index |
| 105 | |
| Tsugikazu Shibata | f012733 | 2017-04-08 12:24:04 +0200 | [diff] [blame] | 106 | Japanese translations |
| 107 | --------------------- |
| 108 | |
| 109 | .. toctree:: |
| 110 | :maxdepth: 1 |
| 111 | |
| 112 | translations/ja_JP/index |
| 113 | |
| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 114 | Indices and tables |
| 115 | ================== |
| 116 | |
| 117 | * :ref:`genindex` |