diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-12-05 06:41:45 -0500 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-12-05 16:21:42 -0500 |
commit | 0f60724f53c2230615c7a3b2abf30a0bc7e8a8de (patch) | |
tree | a532865db97aebb5717d9bbf4c21da973a44b142 | |
parent | a240bfedee7fe2bad1a5ac5d104c513e7fe09d30 (diff) |
docs: 00-INDEX: document directories/files with no docs
There are a number of files/directories that don't contain
any documentation. They're related to ReST file conversion.
As a matter of completeness, since Makefile is also documented
there, add an entry for those files too.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r-- | Documentation/00-INDEX | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX index 272f5c4481f1..6d488509285d 100644 --- a/Documentation/00-INDEX +++ b/Documentation/00-INDEX | |||
@@ -14,6 +14,8 @@ Following translations are available on the WWW: | |||
14 | - this file. | 14 | - this file. |
15 | ABI/ | 15 | ABI/ |
16 | - info on kernel <-> userspace ABI and relative interface stability. | 16 | - info on kernel <-> userspace ABI and relative interface stability. |
17 | CodingStyle | ||
18 | - nothing here, just a pointer to process/coding-style.rst. | ||
17 | DMA-API.txt | 19 | DMA-API.txt |
18 | - DMA API, pci_ API & extensions for non-consistent memory machines. | 20 | - DMA API, pci_ API & extensions for non-consistent memory machines. |
19 | DMA-API-HOWTO.txt | 21 | DMA-API-HOWTO.txt |
@@ -39,6 +41,9 @@ Intel-IOMMU.txt | |||
39 | Makefile | 41 | Makefile |
40 | - This file does nothing. Removing it breaks make htmldocs and | 42 | - This file does nothing. Removing it breaks make htmldocs and |
41 | make distclean. | 43 | make distclean. |
44 | Makefile.sphinx | ||
45 | - This file does nothing. Removing it breaks make htmldocs and | ||
46 | make distclean. | ||
42 | PCI/ | 47 | PCI/ |
43 | - info related to PCI drivers. | 48 | - info related to PCI drivers. |
44 | RCU/ | 49 | RCU/ |
@@ -47,6 +52,8 @@ SAK.txt | |||
47 | - info on Secure Attention Keys. | 52 | - info on Secure Attention Keys. |
48 | SM501.txt | 53 | SM501.txt |
49 | - Silicon Motion SM501 multimedia companion chip | 54 | - Silicon Motion SM501 multimedia companion chip |
55 | SubmittingPatches | ||
56 | - nothing here, just a pointer to process/coding-style.rst. | ||
50 | accounting/ | 57 | accounting/ |
51 | - documentation on accounting and taskstats. | 58 | - documentation on accounting and taskstats. |
52 | acpi/ | 59 | acpi/ |
@@ -93,6 +100,8 @@ clk.txt | |||
93 | - info on the common clock framework | 100 | - info on the common clock framework |
94 | cma/ | 101 | cma/ |
95 | - Continuous Memory Area (CMA) debugfs interface. | 102 | - Continuous Memory Area (CMA) debugfs interface. |
103 | conf.py | ||
104 | - nothing here. Just a configuration file for Sphinx. | ||
96 | connector/ | 105 | connector/ |
97 | - docs on the netlink based userspace<->kernel space communication mod. | 106 | - docs on the netlink based userspace<->kernel space communication mod. |
98 | console/ | 107 | console/ |
@@ -135,6 +144,8 @@ digsig.txt | |||
135 | -info on the Digital Signature Verification API | 144 | -info on the Digital Signature Verification API |
136 | dma-buf-sharing.txt | 145 | dma-buf-sharing.txt |
137 | - the DMA Buffer Sharing API Guide | 146 | - the DMA Buffer Sharing API Guide |
147 | docutils.conf | ||
148 | - nothing here. Just a configuration file for docutils. | ||
138 | dontdiff | 149 | dontdiff |
139 | - file containing a list of files that should never be diff'ed. | 150 | - file containing a list of files that should never be diff'ed. |
140 | driver-api/ | 151 | driver-api/ |
@@ -201,6 +212,8 @@ ide/ | |||
201 | - Information regarding the Enhanced IDE drive. | 212 | - Information regarding the Enhanced IDE drive. |
202 | iio/ | 213 | iio/ |
203 | - info on industrial IIO configfs support. | 214 | - info on industrial IIO configfs support. |
215 | index.rst | ||
216 | - main index for the documentation at ReST format. | ||
204 | infiniband/ | 217 | infiniband/ |
205 | - directory with documents concerning Linux InfiniBand support. | 218 | - directory with documents concerning Linux InfiniBand support. |
206 | input/ | 219 | input/ |
@@ -307,6 +320,8 @@ nvdimm/ | |||
307 | - info on non-volatile devices. | 320 | - info on non-volatile devices. |
308 | nvmem/ | 321 | nvmem/ |
309 | - info on non volatile memory framework. | 322 | - info on non volatile memory framework. |
323 | output/ | ||
324 | - default directory where html/LaTeX/pdf files will be written. | ||
310 | padata.txt | 325 | padata.txt |
311 | - An introduction to the "padata" parallel execution API | 326 | - An introduction to the "padata" parallel execution API |
312 | parisc/ | 327 | parisc/ |
@@ -387,6 +402,10 @@ sound/ | |||
387 | - directory with info on sound card support. | 402 | - directory with info on sound card support. |
388 | spi/ | 403 | spi/ |
389 | - overview of Linux kernel Serial Peripheral Interface (SPI) support. | 404 | - overview of Linux kernel Serial Peripheral Interface (SPI) support. |
405 | sphinx/ | ||
406 | - no doumentation here, just files required by Sphinx toolchain. | ||
407 | sphinx-static/ | ||
408 | - no doumentation here, just files required by Sphinx toolchain. | ||
390 | static-keys.txt | 409 | static-keys.txt |
391 | - info on how static keys allow debug code in hotpaths via patching | 410 | - info on how static keys allow debug code in hotpaths via patching |
392 | svga.txt | 411 | svga.txt |