About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / index.rst




Custom Search

Based on kernel version 4.16.1. Page generated on 2018-04-09 11:53 EST.

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	
6	The Linux Kernel documentation
7	==============================
8	
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	Licensing documentation
17	-----------------------
18	
19	The following describes the license of the Linux kernel source code
20	(GPLv2), how to properly mark the license of individual files in the source
21	tree, as well as links to the full license text.
22	
23	.. toctree::
24	   :maxdepth: 2
25	
26	   process/license-rules.rst
27	
28	User-oriented documentation
29	---------------------------
30	
31	The following manuals are written for *users* of the kernel — those who are
32	trying to get it to work optimally on a given system.
33	
34	.. toctree::
35	   :maxdepth: 2
36	
37	   admin-guide/index
38	
39	Application-developer documentation
40	-----------------------------------
41	
42	The user-space API manual gathers together documents describing aspects of
43	the kernel interface as seen by application developers.
44	
45	.. toctree::
46	   :maxdepth: 2
47	
48	   userspace-api/index	      
49	
50	
51	Introduction to kernel development
52	----------------------------------
53	
54	These manuals contain overall information about how to develop the kernel.
55	The kernel community is quite large, with thousands of developers
56	contributing over the course of a year.  As with any large community,
57	knowing how things are done will make the process of getting your changes
58	merged much easier.
59	
60	.. toctree::
61	   :maxdepth: 2
62	
63	   process/index
64	   dev-tools/index
65	   doc-guide/index
66	   kernel-hacking/index
67	   maintainer/index
68	
69	Kernel API documentation
70	------------------------
71	
72	These books get into the details of how specific kernel subsystems work
73	from the point of view of a kernel developer.  Much of the information here
74	is taken directly from the kernel source, with supplemental material added
75	as needed (or at least as we managed to add it — probably *not* all that is
76	needed).
77	
78	.. toctree::
79	   :maxdepth: 2
80	
81	   driver-api/index
82	   core-api/index
83	   media/index
84	   networking/index
85	   input/index
86	   gpu/index
87	   security/index
88	   sound/index
89	   crypto/index
90	   filesystems/index
91	
92	Architecture-specific documentation
93	-----------------------------------
94	
95	These books provide programming details about architecture-specific
96	implementation.
97	
98	.. toctree::
99	   :maxdepth: 2
100	
101	   sh/index
102	
103	Korean translations
104	-------------------
105	
106	.. toctree::
107	   :maxdepth: 1
108	
109	   translations/ko_KR/index
110	
111	Chinese translations
112	--------------------
113	
114	.. toctree::
115	   :maxdepth: 1
116	
117	   translations/zh_CN/index
118	
119	Japanese translations
120	---------------------
121	
122	.. toctree::
123	   :maxdepth: 1
124	
125	   translations/ja_JP/index
126	
127	Indices and tables
128	==================
129	
130	* :ref:`genindex`
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.