| 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 | |
| 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 |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame] | 54 | |
| 55 | Kernel API documentation |
| 56 | ------------------------ |
| 57 | |
| 58 | These books get into the details of how specific kernel subsystems work |
| 59 | from the point of view of a kernel developer. Much of the information here |
| 60 | is taken directly from the kernel source, with supplemental material added |
| 61 | 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] | 62 | needed). |
| Jonathan Corbet | b51208d | 2016-10-26 15:43:00 -0600 | [diff] [blame] | 63 | |
| 64 | .. toctree:: |
| 65 | :maxdepth: 2 |
| 66 | |
| Jonathan Corbet | dcec3c8 | 2016-08-20 13:17:32 -0600 | [diff] [blame] | 67 | driver-api/index |
| Silvio Fricke | 24755a5 | 2016-10-28 10:14:10 +0200 | [diff] [blame] | 68 | core-api/index |
| Markus Heiser | b32feba | 2016-08-13 16:12:43 +0200 | [diff] [blame] | 69 | media/index |
| Jani Nikula | cb597fc | 2016-06-21 14:48:57 +0300 | [diff] [blame] | 70 | gpu/index |
| Jarkko Sakkinen | 799a545 | 2016-11-03 17:57:52 -0600 | [diff] [blame] | 71 | security/index |
| Takashi Iwai | 8551914 | 2016-11-02 21:30:39 +0100 | [diff] [blame] | 72 | sound/index |
| Stephan Mueller | 3b72c81 | 2016-10-21 04:54:22 +0200 | [diff] [blame] | 73 | crypto/index |
| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 74 | |
| SeongJae Park | ba42c57 | 2016-11-08 21:26:09 +0900 | [diff] [blame] | 75 | Korean translations |
| 76 | ------------------- |
| 77 | |
| 78 | .. toctree:: |
| 79 | :maxdepth: 1 |
| 80 | |
| 81 | translations/ko_KR/index |
| 82 | |
| Andy Deng | 2069889 | 2017-01-25 12:14:33 +0800 | [diff] [blame] | 83 | Chinese translations |
| 84 | -------------------- |
| 85 | |
| 86 | .. toctree:: |
| 87 | :maxdepth: 1 |
| 88 | |
| 89 | translations/zh_CN/index |
| 90 | |
| Tsugikazu Shibata | f012733 | 2017-04-08 12:24:04 +0200 | [diff] [blame] | 91 | Japanese translations |
| 92 | --------------------- |
| 93 | |
| 94 | .. toctree:: |
| 95 | :maxdepth: 1 |
| 96 | |
| 97 | translations/ja_JP/index |
| 98 | |
| Jani Nikula | 22cba31 | 2016-05-19 15:14:05 +0300 | [diff] [blame] | 99 | Indices and tables |
| 100 | ================== |
| 101 | |
| 102 | * :ref:`genindex` |