summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* 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>
| * fs: add a blank lines on some kernel-doc commentsMauro Carvalho Chehab2017-05-163-5/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx gets confused when it finds identation without a good reason for it and without a preceding blank line: ./fs/mpage.c:347: ERROR: Unexpected indentation. ./fs/namei.c:4303: ERROR: Unexpected indentation. ./fs/fs-writeback.c:2060: ERROR: Unexpected indentation. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: don't ignore internal functions for jbd2 docsMauro Carvalho Chehab2017-05-161-1/+0
| | | | | | | | | | | | | | Those functions are currently ignored, causing references at the documentation to be lost. Don't ignore it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * fs: jbd2: make jbd2_journal_start() kernel-doc parseableMauro Carvalho Chehab2017-05-161-19/+19
| | | | | | | | | | | | | | | | | | | | kernel-doc script expects that a function documentation to be just before the function, otherwise it will be ignored. So, move the kernel-doc markup to the right place. Reviewed-by: Jan Kara <jack@suse.cz> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: filesystems: use c domain references where neededMauro Carvalho Chehab2017-05-161-36/+40
| | | | | | | | | | | | | | | | | | | | | | Instead of just mention the function names, use cross-references to the kernel-doc tags where pertinent. While not all function documentation is included here, I double-checked that all functions mentioned there still exists. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: convert filesystems book to ReSTMauro Carvalho Chehab2017-05-166-382/+328
| | | | | | | | | | | | | | 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: add userspace API book to pdf outputMauro Carvalho Chehab2017-05-161-0/+2
| | | | | | | | | | | | | | The userspace API book was added without the bits required to generate PDF output. Add them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: add sound book to pdf outputMauro Carvalho Chehab2017-05-162-0/+12
| | | | | | | | | | | | | | The sound subsystem book was added without the bits required to generate PDF output. Add them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: add dev-tools book to pdf outputMauro Carvalho Chehab2017-05-161-0/+2
| | | | | | | | | | | | | | The dev-tools API book was added without the bits required to generate PDF output at the main conf.py. Add them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: add crypto API book to pdf outputMauro Carvalho Chehab2017-05-162-0/+12
| | | | | | | | | | | | | | The crypto API book was added without the bits required to generate PDF output. Add them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: conf.py: remove kernel-documentation from LaTeXMauro Carvalho Chehab2017-05-161-3/+1
| | | | | | | | | | | | | | | | There's no kernel-documentation.rst file at Documentation/ anymore. So, remove it from the list of LaTeX-generated documents. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: conf.py: sort LaTeX documents in alphabetical orderMauro Carvalho Chehab2017-05-161-6/+7
| | | | | | | | | | | | | | | | As we add more documents, it makes more sense to sort the entries there in alphabetical order, as it makes easier to check if something is not there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * conf.py: define a color for important markup on PDF outputMauro Carvalho Chehab2017-05-161-1/+7
| | | | | | | | | | | | | | As kdbg.rst uses the ".. important::" annotation, let's define a color for PDF output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * kgdb.rst: Adjust ReST markupsMauro Carvalho Chehab2017-05-161-255/+232
| | | | | | | | | | | | | | | | | | The automatic conversion didn't work too well for this file. It added weird html blocks inside it, and did some weird things for literals. Manually fix it, in order to present a nice display at html/pdf outputs. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * docs-rst: convert kgdb DocBook to ReSTMauro Carvalho Chehab2017-05-164-919/+932
| | | | | | | | | | | | | | Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * locking.rst: Update some ReST markupsMauro Carvalho Chehab2017-05-161-8/+8
| | | | | | | | | | | | | | Correct a few minor issues with ReST notation used on this file (produced by an automatic tool). Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * locking.rst: add captions to two tablesMauro Carvalho Chehab2017-05-161-34/+36
| | | | | | | | | | | | | | Those tables have a "caption" at the end, but ReST actually expects it on a different way. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| * locking.rst: reformat locking tableMauro Carvalho Chehab2017-05-161-23/+14
| | | | | | | | | | | | | | Use a different markup for this table, in order to make it smaller when seeing in text mode. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-08 18:02:38 +0100