summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs-4.13' of git://git.lwn.net/linuxLinus Torvalds2017-07-04181-12195/+8403
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull documentation updates from Jonathan Corbet: "There has been a fair amount of activity in the docs tree this time around. Highlights include: - Conversion of a bunch of security documentation into RST - The conversion of the remaining DocBook templates by The Amazing Mauro Machine. We can now drop the entire DocBook build chain. - The usual collection of fixes and minor updates" * tag 'docs-4.13' of git://git.lwn.net/linux: (90 commits) scripts/kernel-doc: handle DECLARE_HASHTABLE Documentation: atomic_ops.txt is core-api/atomic_ops.rst Docs: clean up some DocBook loose ends Make the main documentation title less Geocities Docs: Use kernel-figure in vidioc-g-selection.rst Docs: fix table problems in ras.rst Docs: Fix breakage with Sphinx 1.5 and upper Docs: Include the Latex "ifthen" package doc/kokr/howto: Only send regression fixes after -rc1 docs-rst: fix broken links to dynamic-debug-howto in kernel-parameters doc: Document suitability of IBM Verse for kernel development Doc: fix a markup error in coding-style.rst docs: driver-api: i2c: remove some outdated information Documentation: DMA API: fix a typo in a function name Docs: Insert missing space to separate link from text doc/ko_KR/memory-barriers: Update control-dependencies example Documentation, kbuild: fix typo "minimun" -> "minimum" docs: Fix some formatting issues in request-key.rst doc: ReSTify keys-trusted-encrypted.txt doc: ReSTify keys-request-key.txt ...
| * scripts/kernel-doc: handle DECLARE_HASHTABLEJakub Kicinski2017-07-031-0/+2
| | | | | | | | | | | | | | | | | | DECLARE_HASHTABLE needs similar handling to DECLARE_BITMAP because otherwise kernel-doc assumes the member name is the second, not first macro parameter. Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: atomic_ops.txt is core-api/atomic_ops.rstPalmer Dabbelt2017-06-241-5/+5
| | | | | | | | | | | | | | | | | | | | | | I was reading the memory barries documentation in order to make sure the RISC-V barries were correct, and I found a broken link to the atomic operations documentation. Signed-off-by: Palmer Dabbelt <palmer@dabbelt.com> Acked-by: Will Deacon <will.deacon@arm.com> Acked-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Docs: clean up some DocBook loose endsJonathan Corbet2017-06-239-930/+3
| | | | | | | | | | | | | | | | There were a few bits and pieces left over from the now-disused DocBook toolchain; git rid of them. Reported-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * 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: Use kernel-figure in vidioc-g-selection.rstJonathan Corbet2017-06-231-2/+2
| | | | | | | | | | | | | | ...otherwise the PDF build fails when it can't find constraints.pdf. Acked-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Docs: fix table problems in ras.rstJonathan Corbet2017-06-231-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Two table problems caused the PDF build to fail: - Evidently multirow cells are not appreciated in table headers, so remove such from the "CS Rows" table. - The logging message structure table was incorrectly formatted, with two "+" instead of "|". The HTML build is forgiving of such things, but PDF is not. Acked-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Docs: Fix breakage with Sphinx 1.5 and upperMauro Carvalho Chehab2017-06-231-2/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Commit 85c21e5c3ee7 (docs-rst: better adjust margins and font size) added a \usepackage{geometry} that conflicts with another inclusion deep within the dependencies with newer versions of Sphinx, causing the the PDF build to fail with a "conflicting parameters" error. Detect the Sphinx version, using sphinxsetup for Sphinx versions 1.5 and upper. Fixes: 85c21e5c3ee74fb75d690c57f7066bae7e2dca55 [jc: Tweaked logic to exclude 1.5.x for x < 3 ] Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * Docs: Include the Latex "ifthen" packageJonathan Corbet2017-06-231-0/+1
| | | | | | | | | | | | | | | | | | Otherwise we get PDF build failures when LaTeX refused to acknowledge the existence of \ifthenelse Fixes: 41cff161fe99d1c6a773becc2250a1dc3ac035ff Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc/kokr/howto: Only send regression fixes after -rc1SeongJae Park2017-06-221-8/+10
| | | | | | | | | | | | | | | | This commit applies commit 388f9b20f98d ("Documentation/process/howto: Only send regression fixes after -rc1") to Korean translation. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs-rst: fix broken links to dynamic-debug-howto in kernel-parametersSteffen Maier2017-06-221-2/+4
| | | | | | | | | | | | | | | | | | Another place in lib/Kconfig.debug was already fixed in commit f8998c226587 ("lib/Kconfig.debug: correct documentation paths"). Fixes: 9d85025b0418 ("docs-rst: create an user's manual book") Signed-off-by: Steffen Maier <maier@linux.vnet.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: Document suitability of IBM Verse for kernel developmentStewart Smith2017-06-221-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | IBM Verse is a web UI around Lotus Domino mail servers (much like the Lotus Notes client talks to Domino servers). For various reasons, it is not at all suitable for kernel development, all of which have been raised (repeatedly) internally. Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com> Acked-by: Samuel Mendoza-Jonas <sam@mendozajonas.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Doc: fix a markup error in coding-style.rstAyan Shafqat2017-06-061-2/+2
| | | | | | | | | | | | | | The "\n\t" sequence needs to be quoted or it will not render properly. [jc: no signoff from the author, but it's trivial] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: driver-api: i2c: remove some outdated informationWolfram Sang2017-06-051-5/+4
| | | | | | | | | | | | | | | | | | | | a) Linux can be an I2C slave meanwhile b) all drivers except one use the driver model currently Update the documentation. Signed-off-by: Wolfram Sang <wsa@the-dreams.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: DMA API: fix a typo in a function nameWolfram Sang2017-06-051-1/+1
| | | | | | | | | | | | | | | | Correct the typo, the wrongly typed function does not exist. Fixes: 6c9c6d6301287e ("dma-debug: New interfaces to debug dma mapping errors") Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Docs: Insert missing space to separate link from textSanjeev Gupta2017-06-051-1/+1
| | | | | | | | | | | | | | Korean translation, there should be a space terminating the link. Acked-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc/ko_KR/memory-barriers: Update control-dependencies exampleSeongJae Park2017-06-051-1/+1
| | | | | | | | | | | | | | | | | | This commit applies upstream change, commit b26cfc48e3e0 ("doc: Update control-dependencies section of memory-barriers.txt"), to Korean translation. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Merge remote-tracking branch 'mauro-exp/docbook3' into death-to-docbookJonathan Corbet2017-05-18124-10510/+7468
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Mauro says: This patch series convert the remaining DocBooks to ReST. The first version was originally send as 3 patch series: [PATCH 00/36] Convert DocBook documents to ReST [PATCH 0/5] Convert more books to ReST [PATCH 00/13] Get rid of DocBook The lsm book was added as if it were a text file under Documentation. The plan is to merge it with another file under Documentation/security, after both this series and a security Documentation patch series gets merged. It also adjusts some Sphinx-pedantic errors/warnings on some kernel-doc markups. I also added some patches here to add PDF output for all existing ReST books.
| | * kernel-doc: describe the ``literal`` syntaxMauro Carvalho Chehab2017-05-161-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | changeset b97f193abf83 ("scripts/kernel-doc: fix parser for apostrophes") added support for ``literal`` inside kernel-doc, in order to allow using the "%" symbol inside a literal block, as this is used at printk() description. Document it. Fixes: b97f193abf83 ("scripts/kernel-doc: fix parser for apostrophes") Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: get rid of Documentation/sphinx/tmplcvt scriptMauro Carvalho Chehab2017-05-161-28/+0
| | | | | | | | | | | | | | | | | | | | | As everything was converted to ReST, we don't need this script anymore. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * usb: fix the comment with regards to DocBookMauro Carvalho Chehab2017-05-161-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The USB gadget documentation is not at DocBook anymore. The main file was converted to ReST, and stored at Documentation/driver-api/usb/gadget.rst, but there are still several plain text files related to gadget under Documentation/usb. So, be generic and just mention documentation without specifying where it is. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * fs: fix the location of the kernel-api bookMauro Carvalho Chehab2017-05-161-1/+1
| | | | | | | | | | | | | | | | | | | | | The kernel-api book is now part of the core-api. Update its location. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * lib: update location of kgdb documentationMauro Carvalho Chehab2017-05-161-1/+1
| | | | | | | | | | | | | | | | | | | | | The documentation was moved from DocBook directory. Update its location. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * fs: update location of filesystems documentationMauro Carvalho Chehab2017-05-163-3/+3
| | | | | | | | | | | | | | | | | | | | | The filesystem documentation was moved from DocBook to Documentation/filesystems/. Update it at the sources. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * irq: update genericirq book locationMauro Carvalho Chehab2017-05-163-3/+3
| | | | | | | | | | | | | | | | | | | | | This book got converted from DocBook. Update its references to point to the current location. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * ia64, scsi: update references for the device-io bookMauro Carvalho Chehab2017-05-163-3/+3
| | | | | | | | | | | | | | | | | | | | | The book is now at Documentation/driver-api/device-io.rst. Update such references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * ata: update references for libata documentationMauro Carvalho Chehab2017-05-1625-25/+25
| | | | | | | | | | | | | | | | | | | | | The libata documentation is now using ReST. Update references to it to point to the new place. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * MAINTAINERS: update old references for DocBook directoryMauro Carvalho Chehab2017-05-161-3/+2
| | | | | | | | | | | | | | | | | | | | | As everything was converted, update the references to point to the new places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs: update old references for DocBook from the documentationMauro Carvalho Chehab2017-05-1612-146/+21
| | | | | | | | | | | | | | | | | | | | | | | | DocBook is mentioned several times at the documentation. Update the obsolete references from it at the DocBook. Acked-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs: remove DocBook from the building systemMauro Carvalho Chehab2017-05-1610-277/+132
| | | | | | | | | | | | | | | | | | | | | Now that we don't have any DocBook anymore, remove it from the building system. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: convert lsm from DocBook to ReSTMauro Carvalho Chehab2017-05-164-540/+203
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This file is outdated. Still, as it is the only one left at DocBook dir, convert it, and store it, with a .txt extension, under Documentation/lsm.txt. This way, we can get rid of DocBook from the building system, without needing to wait for someone to take care of it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: convert sh book to ReSTMauro Carvalho Chehab2017-05-166-108/+83
| | | | | | | | | | | | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warningsMauro Carvalho Chehab2017-05-163-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ./drivers/mtd/nand/nand_bbt.c:1: warning: no structured comments found ./include/linux/mtd/nand.h:785: ERROR: Unexpected indentation. ./drivers/mtd/nand/nand_base.c:449: WARNING: Definition list ends without a blank line; unexpected unindent. ./drivers/mtd/nand/nand_base.c:1161: ERROR: Unexpected indentation. ./drivers/mtd/nand/nand_base.c:1162: WARNING: Block quote ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * mtdnand.rst: group the "::" with previous lineMauro Carvalho Chehab2017-05-161-17/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Group the :: with the previous paragraph, in order to make it visually better when reading as a text file. While here, replace: ored (with means "Covered or adorned with ore or metal") by: OR-ed To reflect its true meaning. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: convert mtdnand book to ReSTMauro Carvalho Chehab2017-05-164-1292/+1021
| | | | | | | | | | | | | | | | | | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. The tables were manually adjusted to fit into 80 columns. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: convert librs book to ReSTMauro Carvalho Chehab2017-05-164-290/+214
| | | | | | | | | | | | | | | | | | | | | 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 rapidio book to ReSTMauro Carvalho Chehab2017-05-164-157/+110
| | | | | | | | | | | | | | | | | | | | | 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 w1 book to ReSTMauro Carvalho Chehab2017-05-163-101/+71
| | | | | | | | | | | | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * scsi: fix some kernel-doc markupsMauro Carvalho Chehab2017-05-163-13/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx is very pedantic with regards to ident/spacing. Fix some kernel-doc markups in order to solve those errors/warnings: ./drivers/scsi/scsicam.c:121: WARNING: Inline emphasis start-string without end-string. ./drivers/scsi/scsicam.c:121: WARNING: Inline emphasis start-string without end-string. ./drivers/scsi/scsicam.c:121: WARNING: Inline emphasis start-string without end-string. ./drivers/scsi/scsi_scan.c:1056: ERROR: Unexpected indentation. ./drivers/scsi/scsi_scan.c:1057: WARNING: Block quote ends without a blank line; unexpected unindent. ./drivers/scsi/scsi_transport_fc.c:2918: ERROR: Unexpected indentation. ./drivers/scsi/scsi_transport_fc.c:2921: WARNING: Block quote ends without a blank line; unexpected unindent. ./drivers/scsi/scsi_transport_fc.c:2922: WARNING: Enumerated list ends without a blank line; unexpected unindent. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: convert scsi DocBook to ReSTMauro Carvalho Chehab2017-05-165-418/+352
| | | | | | | | | | | | | | | | | | | | | 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 z8530book DocBook to ReSTMauro Carvalho Chehab2017-05-164-372/+259
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Some manual adjustments were required due to some conversion error on some literals. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * net: fix some identation issues at kernel-doc markupsMauro Carvalho Chehab2017-05-165-12/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx is very pedantic with regards to identation and escape sequences: ./include/net/sock.h:1967: ERROR: Unexpected indentation. ./include/net/sock.h:1969: ERROR: Unexpected indentation. ./include/net/sock.h:1970: WARNING: Block quote ends without a blank line; unexpected unindent. ./include/net/sock.h:1971: WARNING: Block quote ends without a blank line; unexpected unindent. ./include/net/sock.h:2268: WARNING: Inline emphasis start-string without end-string. ./net/core/sock.c:2686: ERROR: Unexpected indentation. ./net/core/sock.c:2687: WARNING: Block quote ends without a blank line; unexpected unindent. ./net/core/datagram.c:182: WARNING: Inline emphasis start-string without end-string. ./include/linux/netdevice.h:1444: ERROR: Unexpected indentation. ./drivers/net/phy/phy.c:381: ERROR: Unexpected indentation. ./drivers/net/phy/phy.c:382: WARNING: Block quote ends without a blank line; unexpected unindent. - Fix spacing where needed; - Properly escape constants; - Use a literal block for a race description. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * net: skbuff.h: properly escape a macro name on kernel-docMauro Carvalho Chehab2017-05-161-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The "%" escape code of kernel-doc only handle letters. It doesn't handle special chars. So, use the ``literal`` notation. That fixes this warning: ./include/linux/skbuff.h:2695: WARNING: Inline literal start-string without end-string. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: convert networking book to ReSTMauro Carvalho Chehab2017-05-167-112/+177
| | | | | | | | | | | | | | | | | | | | | 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 s390-drivers DocBook to ReSTMauro Carvalho Chehab2017-05-164-162/+113
| | | | | | | | | | | | | | | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Acked-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * libata: fix identation on a kernel-doc markupMauro Carvalho Chehab2017-05-161-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx got confused with the markup identation: ./drivers/ata/libata-scsi.c:3402: ERROR: Unexpected indentation. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * libata.rst: add c function and struct cross-referencesMauro Carvalho Chehab2017-05-161-120/+124
| | | | | | | | | | | | | | | | | | | | | | | | Instead of just using text for functions and structs, use the C domain tags, in order to allow cross-referencing with the kernel-doc markups. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * docs-rst: convert libata book to ReSTMauro Carvalho Chehab2017-05-164-1626/+1029
| | | | | | | | | | | | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * fs: jbd2: escape a string with special chars on a kernel-docMauro Carvalho Chehab2017-05-161-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | kernel-doc will try to interpret a foo() string, except if properly escaped. Reviewed-by: Jan Kara <jack@suse.cz> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| | * fs: eventfd: fix identation on kernel-docMauro Carvalho Chehab2017-05-161-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx require explicit tags in order to use a list of possible values, otherwise it produces this error: ./fs/eventfd.c:219: WARNING: Option list ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-27 02:27:32 +0100