| 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 | |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame^] | 6 | Welcome to The Linux Kernel's 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 | |
| 27 | Introduction to kernel development |
| 28 | ---------------------------------- |
| 29 | |
| 30 | These manuals contain overall information about how to develop the kernel. |
| 31 | The kernel community is quite large, with thousands of developers |
| 32 | contributing over the course of a year. As with any large community, |
| 33 | knowing how things are done will make the process of getting your changes |
| 34 | merged much easier. |
| 35 | |
| 36 | .. toctree:: |
| 37 | :maxdepth: 2 |
| 38 | |
| Mauro Carvalho Chehab | 0e4f07a | 2016-10-18 09:05:32 -0200 | [diff] [blame] | 39 | process/index |
| Jonathan Corbet | 059c5e9 | 2016-08-08 16:00:25 -0600 | [diff] [blame] | 40 | dev-tools/tools |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame^] | 41 | kernel-documentation |
| 42 | |
| 43 | Kernel API documentation |
| 44 | ------------------------ |
| 45 | |
| 46 | These books get into the details of how specific kernel subsystems work |
| 47 | from the point of view of a kernel developer. Much of the information here |
| 48 | is taken directly from the kernel source, with supplemental material added |
| 49 | as needed (or at least as we managed to add it — probably *not* all that is |
| 50 | needed). |
| 51 | |
| 52 | .. toctree:: |
| 53 | :maxdepth: 2 |
| 54 | |
| Jonathan Corbet | dcec3c8 | 2016-08-20 13:17:32 -0600 | [diff] [blame] | 55 | driver-api/index |
| Markus Heiser | b32feba | 2016-08-13 16:12:43 +0200 | [diff] [blame] | 56 | media/index |
| Jani Nikula | cb597fc | 2016-06-21 14:48:57 +0300 | [diff] [blame] | 57 | gpu/index |
| Johannes Berg | 819bf59 | 2016-10-11 14:56:53 +0200 | [diff] [blame] | 58 | 80211/index |
| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 59 | |
| 60 | Indices and tables |
| 61 | ================== |
| 62 | |
| 63 | * :ref:`genindex` |
