summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* 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-25149-5546/+6048
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * README: add a new README file, pointing to the Documentation/Mauro Carvalho Chehab2016-10-241-0/+18
| | | | | | | | | | | | | | | | | | | | | | As we moved the real README file to Documentation/admin-guide/README.rst, let's add a replacement, pointing to it, and giving the main directions about documentation. In the future, perhaps it would be worth to move the contents of Documentation/00-Index into this README. 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-24103-278/+280
| | | | | | | | | | | | | | | | 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-11/+53
| | | | | | | | | | | | | | | | | | | | 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>
| * README: convert it to ReST markupMauro Carvalho Chehab2016-10-241-47/+58
| | | | | | | | | | | | | | | | | | | | | | | | | | Adjust the readme file for it to use the ReST markup: - add chapter/section markups; - use ``foo`` for commands; - use :: for verbatim and script blocks; - replace unsupported markup _foo_ by **foo**; - add cross-references to other ReST files; - use lower case on the section titles, to match other ReST files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * REPORTING-BUGS: convert to ReST markupMauro Carvalho Chehab2016-10-241-30/+38
| | | | | | | | | | | | | | | | | | | | | | - add a title to the document; - use :: before verbatim blocks; - add blank lines where required; - use protocol for URL references; - use a verbatim block for the bugs template; - add cross references to SecurityBugs. 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>
| * Documentation/adding-syscalls.txt: convert it to ReST markupMauro Carvalho Chehab2016-10-241-127/+142
| | | | | | | | | | | | | | | | | | | | | | | | | | Convert adding-syscalls.txt to ReST markup and add it to the development-process book: - add extra lines to make Sphinx to correctly parse paragraphs; - use quote blocks for examples; - use monotonic font for dirs, function calls, etc; - mark manpage pages using the right markup; - add cross-reference to SubmittingPatches. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Documentation/applying-patches.txt: fix a bad external linkMauro Carvalho Chehab2016-10-241-1/+1
| | | | | | | | | | | | We can't use :ref: for external links. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | Documentation: cpu-hotplug: Fix typosIgor Vuk2016-10-251-16/+16
| | | | | | | | | | | | | | Fix some minor spelling errors and capitalization issues. Signed-off-by: Igor Vuk <parcijala@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | locking/Doc/ko_KR: Clarify limited control-dependency scopeSeongJae Park2016-10-251-0/+36
|/ | | | | | | | | This commit applies upstream change, commit ebff09a6ff16 ("locking/Documentation: Clarify limited control-dependency scope"), to Korean translation. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* vme: Convert documentation to reStructuredText, move under driver APIsMartyn Welch2016-10-213-28/+90
| | | | | | | | | Perform a relatively simple conversion of vme_api.txt to reStructuredText and move under driver-api, which seems the most logical place for this documentation. Signed-off-by: Martyn Welch <martyn.welch@collabora.co.uk> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Doc: cciss: Fix a typo in cciss.txtMasanari Iida2016-10-211-1/+1
| | | | | | | | This patch fix a spelling typo in cciss.txt Signed-off-by: Masanari Iida <standby24x7@gmail.com> Acked-by: Don Brace <don.brace@microsemi.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc: add documentation for uio-hv-genericStephen Hemminger2016-10-211-0/+62
| | | | | | | | Update UIO documentation to include basic information about uio_hv_generic. Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Doc: dm raid: Fix typo in dm-raid.txtMasanari Iida2016-10-211-4/+4
| | | | | | | This patch fix spelling typos in Documentation/device-mapper/dm-raid.txt. Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/trace/uprobetracer.txt: fix incorrect examplesMarcin Nowakowski2016-10-211-3/+3
| | | | | | | | | | | Current uprobetracer examples don't work as they use an incorrect syntax - if no event name is specified then 'p/r' must not be followed by a colon - if no event name is specified then the default event name will have a 'p_' prefix, so use that in the '-' example as well Signed-off-by: Marcin Nowakowski <marcin.nowakowski@imgtec.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/sphinx: rename kernel-doc.py to kerneldoc.pyJani Nikula2016-10-192-1/+1
| | | | | | | | | | | Python module names should not have hyphens per [PEP 8]. Drop the hyphen from kernel-doc.py. The extension directive remains unchanged. [PEP 8] https://www.python.org/dev/peps/pep-0008/#package-and-module-names Reported-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Linux 4.9-rc1v4.9-rc1Linus Torvalds2016-10-151-2/+2
|
OpenPOWER on IntegriCloud