summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* 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-158-4/+20
| | | | | | | 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-1514-9/+10
| | | | | | 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-1549-45/+71
| | | | | | | | | | | 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-1540-33/+47
| | | | | | | | | | | 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-1536-33/+32
| | | | | | 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-1510-6/+5
| | | | | | | 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-1524-17/+16
| | | | | | | 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-153-3/+2
| | | | | | | 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-153-3/+2
| | | | | | | 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-155-2/+4
| | | | | | | | | 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-1522-26/+24
| | | | | | 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-1514-15/+15
| | | | | | | 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-1517-12/+11
| | | | | | | | 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-1520-13/+12
| | | | | | | | 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-157-6/+5
| | | | | | | 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-1535-6/+5
| | | | | | | 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-153-3/+2
| | | | | | | 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-156-3/+2
| | | | | | | | | | 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-156-3/+2
| | | | | | | 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-1511-5/+4
| | | | | | | | | | 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-1510-4/+3
| | | | | | | | | | 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-154-2/+3
| | | | | | | | 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-1528-345/+545
| | | | | | | | | | | 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-1517-484/+653
| | | | | | | | | | | | | | | | | 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-1510-43/+73
| | | | | | | | | | | 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-1515-246/+399
| | | | | | | | | | | | | | 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-157-77/+141
| | | | | | | | | | | 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-157-1253/+1814
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* docs: ioctl-number.txt: convert it to ReST formatMauro Carvalho Chehab2019-07-156-355/+367
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The conversion itself is simple: add a markup for the title of this file and add markups for both tables. Yet, the big table here with IOCTL numbers is badly formatted: on several lines, the "Include File" column has some values that are bigger than the reserved space there. Also, on several places, a comment was misplaced at the "Include File" space. So, most of the work here is to actually ensure that each field will be properly fixed. Also worth to mention that some URLs have the asterisk character on it. Well, Sphinx has an issue with asterisks in the middle of an string. As this is URL, use the alternate format: %2A. As a side effect of this patch, it is now a lot easier to see that some reserved ioctl numbers are missing the include files where it is supposed to be used. PS.: While this is part of a subdir, I opted to convert this single file alone, as this file has a potential of conflicts, as most subsystem maintainers touch it. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* docs: mmc: convert to ReSTMauro Carvalho Chehab2019-07-155-40/+82
| | | | | | | | | | | Rename the mmc 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: xtensa: convert to ReSTMauro Carvalho Chehab2019-07-156-194/+222
| | | | | | | | | | | Rename the xtensa 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: nvdimm: convert to ReSTMauro Carvalho Chehab2019-07-155-295/+393
| | | | | | | | | | | | Rename the nvdimm 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> Acked-by: Dan Williams <dan.j.williams@intel.com>
* docs: mtd: convert to ReSTMauro Carvalho Chehab2019-07-155-250/+314
| | | | | | | | | | | | | | | | Rename the mtd documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. It should be noticed that Sphinx doesn't handle very well URLs with dots in the middle. Thankfully, internally, the '.' char is translated to %2E, so we can jus use %2E instead of dots, and this will work fine on both text and processed files. 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: md: convert to ReSTMauro Carvalho Chehab2019-07-154-75/+151
| | | | | | | | | | | Rename the md 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: nfc: convert to ReSTMauro Carvalho Chehab2019-07-153-75/+109
| | | | | | | | | | | Rename the nfc 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: namespaces: convert to ReSTMauro Carvalho Chehab2019-07-153-3/+22
| | | | | | | | | | | | | | | Rename the namespaces documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. There are two upper case file names. Rename them to lower case, as we're working to avoid upper case file names at 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: laptops: convert to ReSTMauro Carvalho Chehab2019-07-1515-539/+695
| | | | | | | | | | | | Rename the laptops 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> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-07 18:55:41 +0100