summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs/v5.3-1' of ↵Linus Torvalds2019-07-16460-7417/+10290
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media Pull rst conversion of docs from Mauro Carvalho Chehab: "As agreed with Jon, I'm sending this big series directly to you, c/c him, as this series required a special care, in order to avoid conflicts with other trees" * tag 'docs/v5.3-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media: (77 commits) docs: kbuild: fix build with pdf and fix some minor issues docs: block: fix pdf output docs: arm: fix a breakage with pdf output docs: don't use nested tables docs: gpio: add sysfs interface to the admin-guide docs: locking: add it to the main index docs: add some directories to the main documentation index docs: add SPDX tags to new index files docs: add a memory-devices subdir to driver-api docs: phy: place documentation under driver-api docs: serial: move it to the driver-api docs: driver-api: add remaining converted dirs to it docs: driver-api: add xilinx driver API documentation docs: driver-api: add a series of orphaned documents docs: admin-guide: add a series of orphaned documents docs: cgroup-v1: add it to the admin-guide book docs: aoe: add it to the driver-api book docs: add some documentation dirs to the driver-api book docs: driver-model: move it to the driver-api book docs: lp855x-driver.rst: add it to the driver-api book ...
| * docs: kbuild: fix build with pdf and fix some minor issuesMauro Carvalho Chehab2019-07-155-11/+33
| | | | | | | | | | | | | | | | | | | | | | The tag ".. include" should be replaced by ".. literalinclude" at issues.rst, otherwise it causes TeX to crash due to excessive usage of stack with Sphinx 2.0. While here, solve a few minor issues at the kbuild book output by adding extra blank lines. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: block: fix pdf outputMauro Carvalho Chehab2019-07-151-4/+5
| | | | | | | | | | | | | | | | Add an extra blank line and use a markup for the enumberated list, in order to make it possible to build the block book on pdf format. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: arm: fix a breakage with pdf outputMauro Carvalho Chehab2019-07-151-0/+1
| | | | | | | | | | | | | | | | Add an extra blank line, as otherwise XeLaTex will complain with: ! LaTeX Error: Too deeply nested. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: don't use nested tablesMauro Carvalho Chehab2019-07-154-21/+19
| | | | | | | | | | | | | | | | | | | | | | | | Nested tables aren't supported for pdf output on Sphinx 1.7.9: admin-guide/laptops/sonypi:: nested tables are not yet implemented. admin-guide/laptops/toshiba_haps:: nested tables are not yet implemented. driver-api/nvdimm/btt:: nested tables are not yet implemented. s390/debugging390:: nested tables are not yet implemented. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com> # laptops
| * docs: gpio: add sysfs interface to the admin-guideMauro Carvalho Chehab2019-07-156-5/+6
| | | | | | | | | | | | | | | | While this is stated as obsoleted, the sysfs interface described there is still valid, and belongs to the admin-guide. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Linus Walleij <linus.walleij@linaro.org>
| * docs: locking: add it to the main indexMauro Carvalho Chehab2019-07-152-1/+2
| | | | | | | | | | | | | | The locking directory is part of the Kernel API bookset. Add it to the index file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: add some directories to the main documentation indexMauro Carvalho Chehab2019-07-1513-12/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The contents of those directories were orphaned at the documentation body. While those directories could likely be moved to be inside some guide, I'm opting to just adding their indexes to the main one, removing the :orphan: and adding the SPDX header. For the drivers, the rationale is that the documentation contains a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on separate directories, as we've be doing with similar subsystem-specific docs that were not split yet. For the others, well... I'm too lazy to do the move. Also, it seems to make sense to keep at least some of those at the main dir (like kbuild, for example). In any case, a latter patch could do the move. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
| * docs: add SPDX tags to new index filesMauro Carvalho Chehab2019-07-1521-0/+41
| | | | | | | | | | | | | | | | All those new files I added are under GPL v2.0 license. Add the corresponding SPDX headers to them. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: add a memory-devices subdir to driver-apiMauro Carvalho Chehab2019-07-154-2/+19
| | | | | | | | | | | | | | | | There are two docs describing memory device drivers. Add both to this new chapter of the driver-api. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: phy: place documentation under driver-apiMauro Carvalho Chehab2019-07-157-3/+19
| | | | | | | | | | | | | | This subsystem-specific documentation belongs to the driver-api. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: serial: move it to the driver-apiMauro Carvalho Chehab2019-07-1510-2/+3
| | | | | | | | | | | | The contents of this directory is mostly driver-api stuff. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: driver-api: add remaining converted dirs to itMauro Carvalho Chehab2019-07-157-8/+7
| | | | | | | | | | | | | | | | | | There are a number of driver-specific descriptions that contain a mix of userspace and kernelspace documentation. Just like we did with other similar subsystems, add them at the driver-api groupset, but don't move the directories. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: driver-api: add xilinx driver API documentationMauro Carvalho Chehab2019-07-153-1/+1
| | | | | | | | | | | | | | The current file there (emmi) provides a description of the driver uAPI and kAPI. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: driver-api: add a series of orphaned documentsMauro Carvalho Chehab2019-07-1535-20/+46
| | | | | | | | | | | | | | | | | | | | | | There are lots of documents under Documentation/*.txt and a few other orphan documents elsehwere that belong to the driver-API book. Move them to their right place. Reviewed-by: Cornelia Huck <cohuck@redhat.com> # vfio-related parts Acked-by: Logan Gunthorpe <logang@deltatee.com> # switchtec Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: admin-guide: add a series of orphaned documentsMauro Carvalho Chehab2019-07-1530-16/+30
| | | | | | | | | | | | | | | | | | | | | | There are lots of documents that belong to the admin-guide but are on random places (most under Documentation root dir). Move them to the admin guide. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
| * docs: cgroup-v1: add it to the admin-guide bookMauro Carvalho Chehab2019-07-1528-23/+22
| | | | | | | | | | | | Those files belong to the admin guide, so add them. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: aoe: add it to the driver-api bookMauro Carvalho Chehab2019-07-159-5/+4
| | | | | | | | | | | | | | Those files belong to the admin guide, so add them. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Justin Sanders <justin@coraid.com>
| * docs: add some documentation dirs to the driver-api bookMauro Carvalho Chehab2019-07-155-4/+8
| | | | | | | | | | | | | | | | Those are subsystem docs, with a mix of kABI and user-faced docs. While they're not split, keep the dirs where they are, adding just a pointer to the main index. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: driver-model: move it to the driver-api bookMauro Carvalho Chehab2019-07-1517-9/+8
| | | | | | | | | | | | | | The audience for the Kernel driver-model is clearly Kernel hackers. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com> # ice driver changes
| * docs: lp855x-driver.rst: add it to the driver-api bookMauro Carvalho Chehab2019-07-152-2/+1
| | | | | | | | | | | | | | The content of this file is intended for backlight Kernel developers. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: ocxl.rst: add it to the uAPI bookMauro Carvalho Chehab2019-07-152-2/+1
| | | | | | | | | | | | | | The content of this file is user-faced. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Andrew Donnellan <ajd@linux.ibm.com>
| * docs: x86: move two x86-specific files to x86 arch dirMauro Carvalho Chehab2019-07-153-0/+2
| | | | | | | | | | | | | | | | | | Those two docs belong to the x86 architecture: Documentation/Intel-IOMMU.txt -> Documentation/x86/intel-iommu.rst Documentation/intel_txt.txt -> Documentation/x86/intel_txt.rst Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: security: move some books to it and updateMauro Carvalho Chehab2019-07-157-3/+5
| | | | | | | | | | | | | | | | | | | | | | The following files belong to security: Documentation/security/LSM.rst -> Documentation/security/lsm-development.rst Documentation/lsm.txt -> Documentation/security/lsm.rst Documentation/SAK.txt -> Documentation/security/sak.rst Documentation/siphash.txt -> Documentation/security/siphash.rst Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: blockdev: add it to the admin-guideMauro Carvalho Chehab2019-07-1517-12/+10
| | | | | | | | | | | | The blockdev book basically contains user-faced documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: admin-guide: add kdump documentation into itMauro Carvalho Chehab2019-07-159-9/+9
| | | | | | | | | | | | | | The Kdump documentation describes procedures with admins use in order to solve issues on their systems. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: admin-guide: add laptops documentationMauro Carvalho Chehab2019-07-1514-7/+6
| | | | | | | | | | | | | | | | The docs under Documentation/laptops contain users specific information. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
| * docs: admin-guide: move sysctl directory to itMauro Carvalho Chehab2019-07-1516-9/+8
| | | | | | | | | | | | | | | | The stuff under sysctl describes /sys interface from userspace point of view. So, add it to the admin-guide and remove the :orphan: from its index file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: early-userspace: move to driver-api guideMauro Carvalho Chehab2019-07-156-5/+4
| | | | | | | | | | | | | | Those documents describe a kAPI. So, add to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: device-mapper: move it to the admin-guideMauro Carvalho Chehab2019-07-1531-2/+1
| | | | | | | | | | | | | | The DM support describes lots of aspects related to mapped disk partitions from the userspace PoV. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: add arch doc directories to the indexMauro Carvalho Chehab2019-07-159-14/+11
| | | | | | | | | | | | | | | | Now that several arch documents were converted to ReST, add their indexes to Documentation/index.rst and remove the :orphan: from them. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: interconnect.rst: add it to the driver-api guideMauro Carvalho Chehab2019-07-152-2/+1
| | | | | | | | | | | | | | This is intended for Kernel hackers audience. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Reviewed-by: Georgi Djakov <georgi.djakov@linaro.org>
| * docs: ioctl: add it to the uAPI guideMauro Carvalho Chehab2019-07-153-3/+2
| | | | | | | | | | | | | | While 100% of its contents is userspace, let's keep the dir at the same place, as this is a well-known location. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: leds: add it to the driver-api bookMauro Carvalho Chehab2019-07-152-1/+2
| | | | | | | | | | | | | | | | | | | | | | The contents of leds driver docs is messy: it has lots of admin-guide stuff and kernel internal ones, just like other driver subsystems. I'm opting to keep the dir at the same place and just add a link to it. This makes clearer that this require changes. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: md: move it to the driver-api bookMauro Carvalho Chehab2019-07-155-2/+1
| | | | | | | | | | | | The docs there were meant to be read by a Kernel developer. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: mmc: move it to the driver-apiMauro Carvalho Chehab2019-07-156-2/+1
| | | | | | | | | | | | Most of the stuff here is related to the kAPI. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: nfc: add it to the driver-api bookMauro Carvalho Chehab2019-07-154-2/+1
| | | | | | | | | | | | Most of the descriptions here are oriented to a Kernel developer. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: mtd: move it to the driver-api bookMauro Carvalho Chehab2019-07-155-2/+1
| | | | | | | | | | | | | | | | | | | | While I was tempted to move it to admin-guide, as some docs there are more userspace-faced, there are some very technical discussions about memory error correction code from the Kernel implementer's PoV. So, let's place it inside the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: namespace: move it to the admin-guideMauro Carvalho Chehab2019-07-154-2/+1
| | | | | | | | | | | | | | As stated at the documentation, this is meant to be for users to better understand namespaces. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: nvdimm: add it to the driver-api bookMauro Carvalho Chehab2019-07-155-2/+1
| | | | | | | | | | | | | | The descriptions here are from Kernel driver's PoV. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Dan Williams <dan.j.williams@intel.com>
| * docs: perf: move to the admin-guideMauro Carvalho Chehab2019-07-159-2/+1
| | | | | | | | | | | | | | | | | | | | The perf infrastructure is used for userspace to track issues. At least a good part of what's described here is related to it. So, add it to the admin-guide. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: rapidio: add it to the driver APIMauro Carvalho Chehab2019-07-159-3/+2
| | | | | | | | | | | | | | | | | | | | This is actually a subsystem description, with contains both kAPI and uAPI. While it should ideally be slplit, let's place it at driver-api, as most things are related to kAPI and driver-specific info. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: logo.txt: rename it to COPYING-logoMauro Carvalho Chehab2019-07-151-0/+0
| | | | | | | | | | | | | | | | | | This file has nothing to do with the Kernel documentation. It contains the copyright permissions for Tux at Documentation/logo.gif. So, rename it accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: move gcc_plugins.txt to core-api and rename to .rstMauro Carvalho Chehab2019-07-152-0/+1
| | | | | | | | | | | | | | | | The gcc_plugins.txt file is already a ReST file. Move it to the core-api book while renaming it. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Kees Cook <keescook@chromium.org>
| * docs: block: convert to ReSTMauro Carvalho Chehab2019-07-1520-337/+537
| | | | | | | | | | | | | | | | | | | | | | Rename the block documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: sysctl: convert to ReSTMauro Carvalho Chehab2019-07-1515-482/+651
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Rename the /proc/sys/ documentation files to ReST, using the README file as a template for an index.rst, adding the other files there via TOC markup. Despite being written on different times with different styles, try to make them somewhat coherent with a similar look and feel, ensuring that they'll look nice as both raw text file and as via the html output produced by the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: perf: convert to ReSTMauro Carvalho Chehab2019-07-158-40/+70
| | | | | | | | | | | | | | | | | | | | | | Rename the perf documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: blockdev: convert to ReSTMauro Carvalho Chehab2019-07-1510-233/+386
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Rename the blockdev documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. The drbd sub-directory contains some graphs and data flows. Add those too to the documentation. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: rapidio: convert to ReSTMauro Carvalho Chehab2019-07-156-76/+140
| | | | | | | | | | | | | | | | | | | | | | Rename the rapidio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
| * docs: ioctl: convert to ReSTMauro Carvalho Chehab2019-07-156-1252/+1813
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Rename the iio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. The cdrom.txt and hdio.txt have their own particular syntax. In order to speedup the conversion, I used a small ancillary perl script: my $d; $d .= $_ while(<>); $d =~ s/(\nCDROM\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\nHDIO\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\n\s*usage:)[\s\n]*(\w[^\n]*)/$1:\n\n\t $2\n/g; $d =~ s/(\n\s*)(E\w+[\s\n]*\w[^\n]*)/$1- $2/g; $d =~ s/(\n\s*)(inputs|outputs|notes):\s*(\w[^\n]*)/$1$2:\n\t\t$3\n/g; print $d; It basically add blank lines on a few interesting places. The script is not perfect: still several things require manual work, but it saved quite some time doing some obvious stuff. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-10 10:14:38 +0000