summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Documentation/00-index: update for new core-api folderSilvio Fricke2016-10-284-1/+24
| | | | | Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'doc-tweaks' into docs-nextJonathan Corbet2016-10-2713-168/+137
|\ | | | | | | | | | | | | | | The creation of the admin and process guides is a great thing, but, without care, we risk replacing a messy docs directory with a few messy Sphinx books. In an attempt to head that off and show what I'm thinking, here's a set of tweaks that, I think, make the existing Sphinx-formatted docs a bit more accessible.
| * docs: Add a warning to applying-patches.rstJonathan Corbet2016-10-271-0/+4
| | | | | | | | | | | | | | | | This is ancient stuff and we don't do things this way anymore. In the absence of simply deleting the document, at least add a warning to it. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: add a warning to submitting-drivers.rstJonathan Corbet2016-10-271-0/+8
| | | | | | | | | | | | | | | | This is crufty stuff and should maybe just be deleted, but I'm not quite ready to do that yet. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Collapse the process guide TOCJonathan Corbet2016-10-271-3/+3
| | | | | | | | | | | | | | I believe this makes the page as a whole more approachable. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Tweak submitting-patches.rst formattingJonathan Corbet2016-10-271-10/+6
| | | | | | | | | | | | | | | | | | The main goal here was to get the subsections to show in the TOC as they do for all the other documents. Also call out the DCO in the section title since it's important. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Apply some basic organization to the process guideJonathan Corbet2016-10-272-10/+29
| | | | | | | | | | | | | | | | Put like documents together, with the essential ones at the top, and split the TOC into sections. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Get rid of the "basic profiling" guideJonathan Corbet2016-10-272-69/+0
| | | | | | | | | | | | | | The document has not been touched in over 11 years and doesn't reflect how profiling is done in the perf era. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Get rid of the badRAM guideJonathan Corbet2016-10-272-51/+0
| | | | | | | | | | | | | | The last release of this tool was for 2.6.28; it's hard to see how it has any relevance to current kernels. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Clean up and organize the admin guide a bitJonathan Corbet2016-10-274-17/+45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The admin guide is a good start, but it's time to turn it into something better than an unordered blob of files. This is a first step in that direction. The TOC has been split up and annotated, the guides have been reordered, and minor tweaks have been applied to a few of them. One consequence of splitting up the TOC is that we don't really want to use :numbered: anymore, since the count resets every time and there doesn't seem to be a way to change that. Eventually we probably want to group the documents into sub-books, at which point we can go back to a single TOC, but it's probably early to do that. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: retitle the kernel-documentation.rstJonathan Corbet2016-10-271-3/+3
| | | | | | | | | | | | | | | | | | Let's make the title of this document (which shows up in the top page) better describe its contents. Cc: Jani Nikula <jani.nikula@intel.com> Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Tweak the top-level Sphinx pageJonathan Corbet2016-10-271-4/+41
| | | | | | | | | | | | | | | | | | This will be the initial landing point for readers, so give them a bit of introductory material. Also split the TOC into area-specific chunks to make the whole thing a bit more approachable. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | USB: update intro of documentationOliver Neukum2016-10-271-38/+30
| | | | | | | | | | | | | | | | | | | | It does no good to mention The 2.4 kernel series and neglect USB 3.x and XHCI. Also with type C and micro/mini USB we better not talk about the shape of connectors. Signed-off-by: Oliver Neukum <oneukum@suse.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-rst: build PDF of 80211 and gpu sub-projectMarkus Heiser2016-10-262-0/+10
| | | | | | | | | | | | | | | | This allows to build PDF of only the sub-projects, which reduce the roundtrip compared to build the PDF from the main documentation. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-rst: include index only in subproject AND htmlMarkus Heiser2016-10-264-2/+18
| | | | | | | | | | | | | | | | The index should only be included if the build of the sub-folder is done with the html-builder (HTML output). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-rst: make driver-api folder buildable stand-aloneMarkus Heiser2016-10-262-0/+18
| | | | | | | | | | | | | | | | | | | | | | Add minimal conf.py makes the driver-api folder buildable stand-alone. To build only this folder run:: make SPHINXDIRS=driver-api htmldocs make SPHINXDIRS=driver-api pdfdocs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-rst: make dev-tools folder buildable stand-aloneMarkus Heiser2016-10-263-1/+19
|/ | | | | | | | | | | | Add minimal conf.py and moved dev-tools/tools.rst to dev-tools/index.rst makes the dev-tools folder buildable stand-alone. To build only this folder run:: make SPHINXDIRS=dev-tools htmldocs make SPHINXDIRS=dev-tools pdfdocs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'mauro-books' into docs-nextJonathan Corbet2016-10-25128-5089/+6147
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Merge Mauro's massive patch series creating the process and admin-guide books. I think there's a lot of stuff to clean up here, but there's no point in holding things up for that. Mauro sez: This patch series continues the efforts of converting the Linux Kernel documentation to Sphinx. It contains text to ReST conversion of several files under Documentation, and a few ones under the main dir (README, REPORTING-BUGS). All patches on this series can be found on my development tree: https://git.linuxtv.org/mchehab/experimental.git/log/?h=lkml-books-v2 The Kernel docs html output after this series can be seen at: https://mchehab.fedorapeople.org/kernel_docs/
| * Documentation/00-INDEX: remove legacy media directoriesMauro Carvalho Chehab2016-10-241-4/+0
| | | | | | | | | | | | | | The dvb/ and video4linux/ dirs were removed, as now, all media documentation is under media/. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * doc: re-add CodingStyle and SubmittingPatchesMauro Carvalho Chehab2016-10-242-0/+2
| | | | | | | | | | | | | | | | | | | | | | Those files got moved to Documentation/process, but as they're very well known files, add pointers to their new locations. PS.: I opted to not merge this patch with the previous one in order to make the diff of the previous one more consistent, as it will show only renames. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs: fix locations of several documents that got movedMauro Carvalho Chehab2016-10-2483-247/+249
| | | | | | | | | | | | | | | | The previous patch renamed several files that are cross-referenced along the Kernel documentation. Adjust the links to point to the right places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: create an user's manual bookMauro Carvalho Chehab2016-10-2428-10/+645
| | | | | | | | | | | | | | | | | | | | Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters on an user's manual book. As we'll be numbering the user's manual, remove the manual numbering from SecurityBugs. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: add documents to development-processMauro Carvalho Chehab2016-10-2417-2/+23
| | | | | | | | | | | | | | | | | | | | Add several documents to the development-process ReST book. As we don't want renames, use symlinks instead, keeping those documents on their original place. Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs: rename development-process/ to process/Mauro Carvalho Chehab2016-10-2415-8/+5
| | | | | | | | | | | | | | As we'll type this a lot, after adding CodingStyle & friends, let's rename the directory name to a shorter one. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/CodeOfConflict: convert to ReSTMauro Carvalho Chehab2016-10-241-1/+2
| | | | | | | | | | | | Fix ReST notation for a bullet item Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/parport.txt: fix table to show on LaTeXMauro Carvalho Chehab2016-10-241-11/+22
| | | | | | | | | | | | | | | | | | Sphinx doesn't like nested tables on the LaTex output. So, change the table there to be displayed properly at the PDF output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/volatile-considered-harmful.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-8/+11
| | | | | | | | | | | | | | | | | | - Fix document section markups; - use quote blocks where needed; - adjust spaces and blank lines; - add it to the development-processs book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/VGA-softcursor.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-23/+50
| | | | | | | | | | | | | | | | | | | | - Fix document title; - use quote blocks where needed; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/unicode.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-4/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Probably, unicode is something that we might remove from the docs, as all modern systems support it. Yet, this chapter is fun, as it mentions support for the Klington fictional charset ;) On the other hand, I bet all other OS user manuals explicit mention unicode support. So, convert it to ReST and include it at the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/sysrq.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-117/+149
| | | | | | | | | | | | | | | | | | | | | | - Fix document title; - use a table for the valid commands; - use quote blocks where needed; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/sysfs-rules.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-111/+119
| | | | | | | | | | | | | | | | | | | | - Fix document title; - use quote blocks where needed; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/ramoops.txt: convert it to ReST formatMauro Carvalho Chehab2016-10-241-40/+48
| | | | | | | | | | | | | | | | | | | | - Fix document title; - use quote blocks where needed; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/parport.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-143/+151
| | | | | | | | | | | | | | | | | | | | | | | | - Add a document title; - use quote blocks where needed; - convert parameters to a nested table; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - replace _foo_ by **foo**; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/oops-tracing.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-117/+138
| | | | | | | | | | | | | | | | | | | | | | | | | | - Add a document title; - use .. note:: markup; - use quote blocks where needed; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - replace _foo_ by **foo**; - while here, remove whitespaces at the end of paragraph; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/java.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-115/+129
| | | | | | | | | | | | | | | | | | | | - Fix document title; - use quote blocks where needed; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/mono.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-21/+23
| | | | | | | | | | | | | | | | | | | | | | - Fix document title; - use quote blocks where needed; - use .. note:: for notes; - use monotonic fonts for config options and file names; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/module-signing.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-61/+67
| | | | | | | | | | | | | | | | | | | | | | | | | | - Fix identatio for the document title; - remove its index; - create a table for hash algorithm to be used; - use quote blocks where needed; - use monotonic fonts for parameters; - adjust whitespaces and blank lines; - Fix case on section titles; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/md.txt: Convert to ReST markupMauro Carvalho Chehab2016-10-241-207/+321
| | | | | | | | | | | | | | | | | | | | | | - add a title for the document; - convert some parameters to tables; - use quote blocks where needed; - use monotonic fonts for parameters; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/magic-number.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-105/+111
| | | | | | | | | | | | | | | | | | | | | | - add a title for the document; - convert the table; - use quote block for the changelog; - use monotonic fonts for file names; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/init.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-13/+16
| | | | | | | | | | | | | | | | | | | | - use a quote blocks where needed; - use ``foo`` for monotonic; - adjust whitespaces and blank lines; - fix the second list (that starts with 0, instead of A) - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/initrd.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-91/+108
| | | | | | | | | | | | | | | | | | | | | | - use a quote blocks where needed; - fix the chapter/section/subsection markups; - use ``foo`` for monotonic; - use .. note:: for /sbin/init file permissions; - adjust whitespaces and blank lines; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/dynamic-debug-howto.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-142/+155
| | | | | | | | | | | | | | | | | | | | | | - use a quote blocks where needed; - fix the chapter/section/subsection markups; - use ``foo`` for monotonic; - use .. note:: for the line-range note; - cleanup whitespaces; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/devices.rst: convert it to ReST markupMauro Carvalho Chehab2016-10-241-532/+558
| | | | | | | | | | | | | | | | | | | | | | | | | | - use a quote block for the big device major/minor list; - use tables for the other device tables; - fix the chapter/section/subsection markups; - use ``foo`` for monotonic; - use .. attention:: for the attention note to developers; - use cross-references where needed; - cleanup whitespaces; - add it to the user's book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/BUG-HUNTING: convert to ReST markupMauro Carvalho Chehab2016-10-241-81/+83
| | | | | | | | | | | | | | | | | | | | - Add a document title and remove its own index; - use monotonic fonts for paths; - use quote blocks where needed; - adjust/use spaces to properly format paragraphs; - add it to the user book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/braille-console: convert it to ReST markupMauro Carvalho Chehab2016-10-242-13/+19
| | | | | | | | | | | | | | | | | | | | | | | | - Fix identation for the document title; - use monotonic fonts for paths; - use quote blocks where needed; - adjust spaces to properly format paragraphs; - use :menuselection: and :kbd: for the menu item and keys; - point too the right item at the menu; - add it to the user book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/serial-console.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-31/+35
| | | | | | | | | | | | | | | | | | | | | | - Fix identation for the document title; - use monotonic fonts for paths; - use quote blocks where needed; - adjust spaces to properly format paragraphs; - use :menuselection: for the menu item; - add it to the user book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/binfmt_misc.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-57/+77
| | | | | | | | | | | | | | | | | | | | - Fix identation for the document title; - use monotonic fonts for commands, paths, etc; - use quote blocks where needed; - adjust spaces to properly format paragraphs; - add it to the user book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/basic_profiling.rst: convert to ReST markupMauro Carvalho Chehab2016-10-241-23/+36
| | | | | | | | | | | | | | | | | | | | | | | | Convert it to ReST markup and add it to the user book: - Add a title to the document; - touch spaces/new lines to fix Sphinx format; - use ``foo`` for commands; - use quote blocks where needed; - add it to the user book; Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/bad_memory.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-10/+16
| | | | | | | | | | | | | | | | | | - promote the section level of the document name; - add/remove spaces/new lines where needed to format the output; - use quote blocks. - add it to the user book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/kernel-parameters.txt: convert to ReST markupMauro Carvalho Chehab2016-10-241-14/+19
| | | | | | | | | | | | | | | | | | | | Adjust the file for it to be parsed by Sphinx: - adjust the document title to be parsed; - use :: for quote blocks; - fix the horizontal bar markup; - lower case the TODO title. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-08-11 12:28:10 +0000