summaryrefslogtreecommitdiffstats
path: root/Documentation/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* Make the main documentation title less GeocitiesKonstantin Ryabitsev2017-06-231-2/+2
| | | | | | | | | | | This is probably the lamest patch ever, but then again "Welcome to The Linux Kernel's documentation" is nearly equally lame. Really, we don't need to "Welcome" people to the documentation, just tell them what the site is about. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org> Acked-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: convert sh book to ReSTMauro Carvalho Chehab2017-05-161-0/+11
| | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs-rst: convert networking book to ReSTMauro Carvalho Chehab2017-05-161-0/+1
| | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs-rst: convert filesystems book to ReSTMauro Carvalho Chehab2017-05-161-0/+1
| | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs-rst: convert kernel-hacking to ReSTMauro Carvalho Chehab2017-05-161-0/+1
| | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. - Manually adjusted to use ..note and ..warning - Minor fixes for it to be parsed without errors - Use **bold** for emphasis. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs-rst: add input docs at main index and use kernel-figureMauro Carvalho Chehab2017-05-091-0/+1
| | | | | | | | | | The input subsystem documentation got converted into ReST. Add it to the main documentation index and use kernel-figure for the two svg images there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'user-space-api' into docs-nextJonathan Corbet2017-04-081-0/+12
|\ | | | | | | | | Create a beginning user-space API manual, and add one old doc that nobody cares much about. More useful stuff should come soon...
| * docs: Create a user-space API guideJonathan Corbet2017-04-021-0/+12
| | | | | | | | | | | | | | This is meant to be the place for documentation relevant to application developers. It's empty for the moment, but at least we have a place now! Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Documentation: Add HOWTO Japanese translation into rst based build systemTsugikazu Shibata2017-04-081-0/+8
|/ | | | | | | | | This commit adds Japanese translation of HOWTO document into rst based documentation build system with updates. Signed-off-by: Tsugikazu Shibata <tshibata@ab.jp.nec.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/zh_CN: Add coding-style into docs build systemAndy Deng2017-01-261-1/+9
| | | | | | | | | | | | Tested by the command: make htmldocs During the compiling process, zh_CN/coding-style.rst has no errors and warnings generated, the generated html document has been checked. Signed-off-by: Andy Deng <theandy.deng@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* crypto: doc - convert crypto API documentation to SphinxStephan Mueller2016-12-141-0/+1
| | | | | | | | | | With the conversion of the kernel crypto API DocBook to Sphinx, the monolithic document is broken up into individual documents. The documentation is unchanged with the exception of a slight reordering to keep the individual document parts self-contained. Signed-off-by: Stephan Mueller <smueller@chronox.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Move the 802.11 guide into the driver-api manualJonathan Corbet2016-11-291-1/+0Star
| | | | | | | | Put this documentation with the other driver docs and try to keep the top level reasonably clean. Cc: Johannes Berg <johannes.berg@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: doc-guide: split the kernel-documentation.rst contentsMauro Carvalho Chehab2016-11-191-1/+1
| | | | | | | | | Having the kernel-documentation at the topmost level doesn't allow generating a separate PDF file for it. Also, makes harder to add extra contents. So, place it on a sub-dir. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge remote-tracking branch 'sound/topic/restize-docs' into soundJonathan Corbet2016-11-191-0/+1
|\ | | | | | | Bring in the sphinxification of the sound documentation.
| * ALSA: doc: ReSTize alsa-driver-api documentTakashi Iwai2016-11-101-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | A simple conversion of alsa-driver-api document from DocBook to ReST. It's moved to the new Documentation/sound/kernel-api subdirectory that will contain other ALSA kernel API documents. The GPL legal note was removed, as it's superfluous (and doesn't fit with ReST kernel docs pretty well). Signed-off-by: Takashi Iwai <tiwai@suse.de>
* | Documentation: Add HOWTO Korean translation into rst based build systemSeongJae Park2016-11-131-0/+8
| | | | | | | | | | | | | | | | This commit adds Korean translation of HOWTO document into rst based documentation build system. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Merge branch 'tpm' into docs-nextJonathan Corbet2016-11-081-0/+1
|\ \
| * | tpm: move documentation under Documentation/securityJarkko Sakkinen2016-11-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | In order too make Documentation root directory cleaner move the tpm directory under Documentation/security. Signed-off-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | tpm: transition tpm_vtpm_proxy documentation to the SphinxJarkko Sakkinen2016-11-081-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Transitioned the tpm_vtpm_proxy documentation to the Sphinx infrastructure and removed parts from the documentation that are easier to pull from the sources. Restructured vtpm_proxy.h and tpm_vtpm_proxy.c to be compatible with this approach and wrote associated documentation comments. Signed-off-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | | Documentation/00-index: update for new core-api folderSilvio Fricke2016-10-281-0/+1
| | | | | | | | | | | | | | | 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-281-4/+41
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Tweak the top-level Sphinx pageJonathan Corbet2016-10-281-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>
* | | | doc-rst: make dev-tools folder buildable stand-aloneMarkus Heiser2016-10-271-1/+1
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | docs-rst: create an user's manual bookMauro Carvalho Chehab2016-10-241-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: rename development-process/ to process/Mauro Carvalho Chehab2016-10-241-1/+1
| |/ |/| | | | | | | | | | | 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>
* | docs-rst: sphinxify 802.11 documentationJohannes Berg2016-10-121-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | This is just a very basic conversion, I've split up the original multi-book template, and also split up the multi-part mac80211 part in the original book; neither of those were handled by the automatic pandoc conversion. Fix errors that showed up, resulting in a much nicer rendering, at least for the interface combinations documentation. Signed-off-by: Johannes Berg <johannes.berg@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: create a book for the development processMauro Carvalho Chehab2016-09-211-0/+1
| | | | | | | | | | | | | | | | | | | | | | Now that the files at Documentation/development-process/ were converted to ReST, make create a book at Sphinx. As we'll have other books related to the development process, we'll add it as a sub-book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: split up the driver bookJonathan Corbet2016-08-221-1/+1
| | | | | | | | | | | | | | | | We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Docs: sphinxify device-drivers.tmplJonathan Corbet2016-08-221-0/+1
| | | | | | | | | | | | | | Perform a basic sphinx conversion of the device-drivers docbook and move it to its own directory. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Merge branch 'dev-tools' into doc/4.9Jonathan Corbet2016-08-191-0/+1
|\ \ | | | | | | | | | | | | Coalesce development-tool documents into a single directory and sphinxify them.
| * | docs: create a new dev-tools directoryJonathan Corbet2016-08-191-0/+1
| |/ | | | | | | | | | | | | | | This directory will be a collecting point for documentation oriented around development tools. As a step toward ordering Documentation/ it's a small one, but we have to start somewhere... Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-rst: add index to sub-foldersMarkus Heiser2016-08-181-1/+0Star
| | | | | | | | | | | | | | | | | | | | | | Add a index if only a sub-folder is build e.g.:: make SPHINXDIRS=media cleandocs htmldocs BTW: removed dead search link in the top-index file Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-rst: add stand-alone conf.py to media folderMarkus Heiser2016-08-141-6/+1Star
|/ | | | | | | | With the media/conf.py, and media/index.rst the media folder can be build and distributed stand-alone. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge tag 'drm-for-v4.8' of git://people.freedesktop.org/~airlied/linuxLinus Torvalds2016-08-021-0/+1
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Merge drm updates from Dave Airlie: "This is the main drm pull request for 4.8. I'm down with a cold at the moment so hopefully this isn't in too bad a state, I finished pulling stuff last week mostly (nouveau fixes just went in today), so only this message should be influenced by illness. Apologies to anyone who's major feature I missed :-) Core: Lockless GEM BO freeing Non-blocking atomic work Documentation changes (rst/sphinx) Prep for new fencing changes Simple display helpers Master/auth changes Register/unregister rework Loads of trivial patches/fixes. New stuff: ARM Mali display driver (not the 3D chip) sii902x RGB->HDMI bridge Panel: Support for new panels Improved backlight support Bridge: Convert ADV7511 to bridge driver ADV7533 support TC358767 (DSI/DPI to eDP) encoder chip support i915: BXT support enabled by default GVT-g infrastructure GuC command submission and fixes BXT workarounds SKL/BKL workarounds Demidlayering device registration Thundering herd fixes Missing pci ids Atomic updates amdgpu/radeon: ATPX improvements for better dGPU power control on PX systems New power features for CZ/BR/ST Pipelined BO moves and evictions in TTM GPU scheduler improvements GPU reset improvements Overclocking on dGPUs with amdgpu Polaris powermanagement enabled nouveau: GK20A/GM20B volt and clock improvements. Initial support for GP100/GP104 GPUs, GP104 will not yet support acceleration due to NVIDIA having not released firmware for them as of yet. exynos: Exynos5433 SoC with IOMMU support. vc4: Shader validation for branching imx-drm: Atomic mode setting conversion Reworked DMFC FIFO allocation External bridge support analogix-dp: RK3399 eDP support Lots of fixes. rockchip: Lots of small fixes. msm: DT bindings cleanups Shrinker and madvise support ASoC HDMI codec support tegra: Host1x driver cleanups SOR reworking for DP support Runtime PM support omapdrm: PLL enhancements Header refactoring Gamma table support arcgpu: Simulator support virtio-gpu: Atomic modesetting fixes. rcar-du: Misc fixes. mediatek: MT8173 HDMI support sti: ASOC HDMI codec support Minor fixes fsl-dcu: Suspend/resume support Bridge support amdkfd: Minor fixes. etnaviv: Enable GPU clock gating hisilicon: Vblank and other fixes" * tag 'drm-for-v4.8' of git://people.freedesktop.org/~airlied/linux: (1575 commits) drm/nouveau/gr/nv3x: fix instobj write offsets in gr setup drm/nouveau/acpi: fix lockup with PCIe runtime PM drm/nouveau/acpi: check for function 0x1B before using it drm/nouveau/acpi: return supported DSM functions drm/nouveau/acpi: ensure matching ACPI handle and supported functions drm/nouveau/fbcon: fix font width not divisible by 8 drm/amd/powerplay: remove enable_clock_power_gatings_tasks from initialize and resume events drm/amd/powerplay: move clockgating to after ungating power in pp for uvd/vce drm/amdgpu: add query device id and revision id into system info entry at CGS drm/amdgpu: add new definition in bif header drm/amd/powerplay: rename smum header guards drm/amdgpu: enable UVD context buffer for older HW drm/amdgpu: fix default UVD context size drm/amdgpu: fix incorrect type of info_id drm/amdgpu: make amdgpu_cgs_call_acpi_method as static drm/amdgpu: comment out unused defaults_staturn_pro static const structure to fix the build drm/amdgpu: enable UVD VM only on polaris drm/amdgpu: increase timeout of IB test drm/amdgpu: add destroy session when generate VCE destroy msg. drm/amd: fix deadlock of job_list_lock V2 ...
| * Documentation/gpu: add new gpu.rst converted from DocBook gpu.tmplJani Nikula2016-06-211-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is the first step towards converting the DocBook gpu.tmpl to Sphinx and reStructuredText, the new kernel documentation tool and markup. Use Jon's "cheesy conversion script" in Documentation/sphinx/tmplcvt to do the rough conversion. Do the manual edits in follow-up patches. Add a new Documentation/gpu directories for the graphics related documentation. (Hooray, now we can have directories based on topics rather than tools under Documentation.) We also won't remove the DocBook gpu.tmpl yet so it's easier to build both and compare the results for parity. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: http://patchwork.freedesktop.org/patch/msgid/bc7b4f9ac037632e0c8469c079d21fad5eaa39a0.1466506505.git.jani.nikula@intel.com
* | [media] doc-rst: better name the media booksMauro Carvalho Chehab2016-07-181-1/+1
| | | | | | | | | | | | | | | | | | | | | | The titles at the media books were misleading, and some books were not numbered. Rename the kAPI book to better reflect its contents, be more consistent on the initial rst file for each book and better name them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | doc-rst: add v4l-drivers to index fileMauro Carvalho Chehab2016-07-171-0/+1
| | | | | | | | | | | | Adds documentation for V4L drivers. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] add DVB documentation to SphinxMauro Carvalho Chehab2016-07-171-0/+1
| | | | | | | | | | | | | | Now that all DVB files got converted, add it to Sphinx build. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: Convert media API to rstMauro Carvalho Chehab2016-07-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | doc_rst: rename the media Sphinx suff to Documentation/mediaMauro Carvalho Chehab2016-07-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | The name of the subsystem is "media", and not "linux_tv". Also, as we plan to add other stuff there in the future, let's rename also the media uAPI book to media_uapi, to make it clearer. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | doc-rst: linux_tv DocBook to reST migration (docs-next)Markus Heiser2016-06-301-0/+1
| | | | | | | | | | | | | | | | This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | Documentation: add meta-documentation for Sphinx and kernel-docJani Nikula2016-06-241-0/+1
| | | | | | | | | | | | | | | | | | | | | | Describe Sphinx, reStructuredText, the kernel-doc extension, the kernel-doc structured documentation comments, etc. The kernel-doc parts are based on kernel-doc-nano-HOWTO.txt, by Tim <twaugh@redhat.com>. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Documentation/sphinx: drop modindex, we don't have python modulesJani Nikula2016-06-231-2/+0Star
|/ | | | | | The modindex is for python modules. Signed-off-by: Jani Nikula <jani.nikula@intel.com>
* Documentation/sphinx: add basic working Sphinx configuration and buildJani Nikula2016-05-301-0/+23
Add basic configuration and makefile to build documentation from any .rst files under Documentation using Sphinx. For starters, there's just the placeholder index.rst. At the top level Makefile, hook Sphinx documentation targets alongside (but independent of) the DocBook toolchain, having both be run on the various 'make *docs' targets. All Sphinx processing is placed into Documentation/Makefile.sphinx. Both that and the Documentation/DocBook/Makefile are now expected to handle all the documentation targets, explicitly ignoring them if they're not relevant for that particular toolchain. The changes to the existing DocBook Makefile are kept minimal. There is graceful handling of missing Sphinx and rst2pdf (which is needed for pdf output) by checking for the tool and python module, respectively, with informative messages to the user. If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but otherwise gracefully fall back to the Sphinx default theme, with an informative message to the user, and slightly less pretty HTML output. Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available), epubdocs and xmldocs targets. The output documents are written into per output type subdirectories under Documentation/output. Finally, you can pass options to sphinx-build using the SPHINXBUILD make variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose output from Sphinx. This is based on the original work by Jonathan Corbet, but he probably wouldn't recognize this as his own anymore. Signed-off-by: Jani Nikula <jani.nikula@intel.com>
generated by cgit v1.2.3-55-g7522 (git 2.39.0) at 2024-11-19 09:46:21 +0100