summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAge
* Documentation/sphinx: set literal block highlight language to noneJani Nikula2016-11-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Set the default highlight language to "none", i.e. do not try to guess the language and do automatic syntax highlighting on literal blocks. Eyeballing around the generated documentation, we don't seem to actually have a lot of literal blocks that would benefit from syntax highlighting. The C code blocks we do have are typically very short, and most of the literal blocks are things that shouldn't be highlighted (or, do not have a pygments lexer). This seems to be true for literal blocks both in the rst source files and in source code comments. Not highlighting code is never wrong, but guessing the language wrong almost invariably leads to silly or confusing highlighting. At the time of writing, admin-guide/oops-tracing.rst and admin-guide/ramoops.rst contain good examples of 1) a small C code snippet not highlighted, 2) a hex dump highligted as who knows what, 3) device tree block highlighted as C or maybe Python, 4) a terminal interaction highlighted as code in some language, and finally, 5) some C code snippets correctly identified as C. I think we're better off disabling language guessing, and going by explicitly identified languages for longer code blocks. It is still possible to enable highlighting on an rst source file basis using the highlight directive: .. higlight:: language and on a literal block basis using the code-block directive: .. code-block:: language See http://www.sphinx-doc.org/en/latest/markup/code.html for details. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Cc: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Documentation/sphinx: include admin-guide in the latex/pdf buildJani Nikula2016-11-03
| | | | | | | | | | Fix the warning: WARNING: "latex_documents" config value references unknown document user/index Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Documentation/sphinx: fix make SPHINXDIRS="dirs" pdfdocs for more than one dirMarkus Heiser2016-11-03
| | | | | | | | | Add missing semicolon to fix pdf build with more than one SPHINXDIRS directory specified. For example make SPHINXDIRS="gpu media" pdfdocs. Fixes: cd21379b1698 ("doc-rst: generic way to build PDF of sub-folders") Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Documentation/sphinx: change pdflatex interaction mode to batchmodeJani Nikula2016-11-03
| | | | | | | | | | Radically reduce the noise on stdout. The full build logs will still be available under Documentatio/output/latex/*.log. Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Tested-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Documentation/sphinx: remove superfluous trailing ; from quiet_cmd_sphinxJani Nikula2016-11-03
| | | | | | | | With the unnecessary ; removed, the terminal URL detection also works better. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Documentation/sphinx: make it possible to build latexdocs without pdflatexJani Nikula2016-11-03
| | | | | | | | | | | Building latexdocs doesn't actually require $(PDFLATEX). Move the checks for it to the pdfdocs target which does require it, and specifically outside of the target in order to not depend on latexdocs when we can't build pdfdocs anyway. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Tested-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Documentation/sphinx: let the user specify PDFLATEX and LATEXOPTSJani Nikula2016-11-03
| | | | | | | | | | Refer to xelatex and latex options via variables. This allows the user to override the pdflatex and latex options to use on the make command line for experimenting. As a side effect, this makes the makefile a bit tidier. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Merge branch 'doc-tweaks' into docs-nextJonathan Corbet2016-10-27
|\ | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | | | 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-27
| | | | | | | | | | | | | | | | | | | | 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-26
| | | | | | | | | | | | | | | | 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-26
| | | | | | | | | | | | | | | | 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-26
| | | | | | | | | | | | | | | | | | | | | | 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-26
|/ | | | | | | | | | | | 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-25
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-24
| | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | - 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-24
| | | | | | | | | | | | | | | | | | | | | | - 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>
generated by cgit v1.2.2 (git 2.25.0) at 2026-03-06 12:14:36 -0500