summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* dt-bindings: input: ti,drv260x: fix typo in property nameAndrea Merello2017-07-171-1/+1
| | | | | | | | | The driver looks for "vib-overdrive-mv" property, while in documentation we have "vib-overdriver-mv". Fix the doc. Cc: Francesco Diotalevi <francesco.diotalevi@iit.it> Signed-off-by: Andrea Merello <andrea.merello@gmail.com> Signed-off-by: Rob Herring <robh@kernel.org>
* dt-bindings: clock: ti-sci: Fix incorrect usage of headersSuman Anna2017-07-171-4/+3
| | | | | | | | | | | | | The clock consumer usage description was erroneously referring to couple of dt-binding headers that are no longer valid. The definition and/or usage of these headers is incorrect and the only file present at the moment, dt-bindings/soc/k2g.h is also being cleaned up. The examples in this binding were updated properly, but the update to description was missed out. So, fix this. Fixes: 8f306cfe4383 ("Documentation: dt: Add TI SCI clock driver") Signed-off-by: Suman Anna <s-anna@ti.com> Signed-off-by: Rob Herring <robh@kernel.org>
* staging: iio: tsl2x7x: add device tree documentationBrian Masney2017-07-171-0/+10
| | | | | | | | | | | Add device tree documentation for the tsl2x7x IIO driver. Signed-off-by: Brian Masney <masneyb@onstation.org> CC: Rob Herring <robh+dt@kernel.org> CC: Mark Rutland <mark.rutland@arm.com> CC: devicetree@vger.kernel.org Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Signed-off-by: Rob Herring <robh@kernel.org>
* dt-bindings: nvmem: mediatek: add support for MediaTek MT7623 and MT7622 SoCSean Wang2017-07-171-1/+4
| | | | | | | | | | | This updates dt-binding documentation for MediaTek MT7622 and MT7623 SoC. For the both SoCs supported all rely on the fallback binding of the generic case with "mediatek,efuse". Signed-off-by: Sean Wang <sean.wang@mediatek.com> Signed-off-by: Andrew-CT Chen <andrew-ct.chen@mediatek.com> Reviewed-by: Matthias Brugger <matthias.bgg@gmail.com> Signed-off-by: Rob Herring <robh@kernel.org>
* clk: si5351: expand compatible strings in documentationBrandon Streiff2017-07-171-1/+5
| | | | | | | | | | | checkpatch.pl doesn't know how to expand "silabs,si5351{a,a-msop,b,c}" and so generates warnings about si5351-compatible devices appearing to be un-documented. Resolve this by documenting the compatible options supported by the clk-si5351 driver individually. Signed-off-by: Brandon Streiff <brandon.streiff@ni.com> Acked-by: Stephen Boyd <sboyd@codeaurora.org> Signed-off-by: Rob Herring <robh@kernel.org>
* Linux v4.13-rc1v4.13-rc1Linus Torvalds2017-07-161-2/+2
|
* Merge tag 'standardize-docs' of git://git.lwn.net/linuxLinus Torvalds2017-07-1581-4731/+6263
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull documentation format standardization from Jonathan Corbet: "This series converts a number of top-level documents to the RST format without incorporating them into the Sphinx tree. The hope is to bring some uniformity to kernel documentation and, perhaps more importantly, have our existing docs serve as an example of the desired formatting for those that will be added later. Mauro has gone through and fixed up a lot of top-level documentation files to make them conform to the RST format, but without moving or renaming them in any way. This will help when we incorporate the ones we want to keep into the Sphinx doctree, but the real purpose is to bring a bit of uniformity to our documentation and let the top-level docs serve as examples for those writing new ones" * tag 'standardize-docs' of git://git.lwn.net/linux: (84 commits) docs: kprobes.txt: Fix whitespacing tee.txt: standardize document format cgroup-v2.txt: standardize document format dell_rbu.txt: standardize document format zorro.txt: standardize document format xz.txt: standardize document format xillybus.txt: standardize document format vfio.txt: standardize document format vfio-mediated-device.txt: standardize document format unaligned-memory-access.txt: standardize document format this_cpu_ops.txt: standardize document format svga.txt: standardize document format static-keys.txt: standardize document format smsc_ece1099.txt: standardize document format SM501.txt: standardize document format siphash.txt: standardize document format sgi-ioc4.txt: standardize document format SAK.txt: standardize document format rpmsg.txt: standardize document format robust-futexes.txt: standardize document format ...
| * docs: kprobes.txt: Fix whitespacingMauro Carvalho Chehab2017-07-141-1/+2
| | | | | | | | | | | | | | | | The notes at the end of this file start with a blank space, instead of a blank line, violating ReST format. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * tee.txt: standardize document formatMauro Carvalho Chehab2017-07-141-22/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - adjust identation of titles; - mark ascii artwork as a literal block; - adjust references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * cgroup-v2.txt: standardize document formatMauro Carvalho Chehab2017-07-141-221/+239
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Comment the internal index; - Use :Date: and :Author: for authorship; - Mark titles; - Mark literal blocks; - Adjust witespaces; - Mark notes; - Use table notation for the existing tables. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * dell_rbu.txt: standardize document formatMauro Carvalho Chehab2017-07-141-25/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx. Currently, the document is completely unformatted. Add titles, do indentation, mark literal blocks. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * zorro.txt: standardize document formatMauro Carvalho Chehab2017-07-141-29/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Use right marks for titles; - Use authorship marks; - Mark literals and literal blocks; - Use autonumbered list for references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * xz.txt: standardize document formatMauro Carvalho Chehab2017-07-141-97/+103
| | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Use marks for titles; - Adjust indentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * xillybus.txt: standardize document formatMauro Carvalho Chehab2017-07-141-15/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Adjust indentation; - Mark authorship; - Comment internal contents table; - Mark literal blocks; - Don't use all-upercase titles. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * vfio.txt: standardize document formatMauro Carvalho Chehab2017-07-141-137/+144
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - adjust title marks; - use footnote marks; - mark literal blocks; - adjust identation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * vfio-mediated-device.txt: standardize document formatMauro Carvalho Chehab2017-07-141-129/+137
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! In this specific document, the title, copyright and authorship are added as if it were a C file! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - convert document preambule to the proper format; - mark literal blocks; - adjust identation; - use numbered lists for references. Reviewed by: Kirti Wankhede <kwankhede@nvidia.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * unaligned-memory-access.txt: standardize document formatMauro Carvalho Chehab2017-07-141-27/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - promote document title one level; - use markups for authorship and put it at the beginning; - mark literal blocks; - adjust identation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * this_cpu_ops.txt: standardize document formatMauro Carvalho Chehab2017-07-141-21/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - promote document title one level; - mark literal blocks; - move authorship to the beginning of the file and use markups. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * svga.txt: standardize document formatMauro Carvalho Chehab2017-07-141-66/+80
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Use standard notation for titles; - Use the note mark; - mark literal blocks; - adjust identation; - mark the table. Acked-By: Martin Mares <mj@ucw.cz> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * static-keys.txt: standardize document formatMauro Carvalho Chehab2017-07-141-99/+108
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Mark titles; - Add a warning mark; - Mark literals and literal blocks; - Adjust identation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * smsc_ece1099.txt: standardize document formatMauro Carvalho Chehab2017-07-141-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Add a title for the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * SM501.txt: standardize document formatMauro Carvalho Chehab2017-07-141-3/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - adjust document title; - use the copyright markup. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * siphash.txt: standardize document formatMauro Carvalho Chehab2017-07-141-75/+89
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Mark titles; - Mark literal blocks; - Use :Author: for authorship; - Don't sumerate chapters; - Adjust identation. NOTE: This file has actually two documents inside it, the first one describing siphash, the second one describing halfsiphash. It is likely a good idea to split them when it gets moved to security/ (which is where it probably belongs). Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * sgi-ioc4.txt: standardize document formatMauro Carvalho Chehab2017-07-141-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx. In this case, just adding a title is enough. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * SAK.txt: standardize document formatMauro Carvalho Chehab2017-07-141-31/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark document title; - use :Author: and :Date: for authorship; - adjust notation for literals and bold; - mark literal blocks; - adjust identation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * rpmsg.txt: standardize document formatMauro Carvalho Chehab2017-07-141-144/+204
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark document and chapter titles; - mark notes; - mark literal blocks; - adjust identation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * robust-futexes.txt: standardize document formatMauro Carvalho Chehab2017-07-141-4/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - add a title for the document; - mark literal blocks; Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * robust-futex-ABI.txt: standardize document formatMauro Carvalho Chehab2017-07-141-5/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - promote document title; - use :Author: for authorship; - mark literal blocks; - add blank lines. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * rfkill.txt: standardize document formatMauro Carvalho Chehab2017-07-141-17/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark titles; - comment contents index; - mark literal blocks; - adjust identation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * remoteproc.txt: standardize document formatMauro Carvalho Chehab2017-07-141-139/+189
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark document and section titles; - adjust identation; - mark literal blocks Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * rbtree.txt: standardize document formatMauro Carvalho Chehab2017-07-141-42/+46
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Mark document title; - Use :Author: for authorship; - mark a sub-section title as such; - mark literal blocks; - adjust identation where needed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * printk-formats.txt: standardize document formatMauro Carvalho Chehab2017-07-141-155/+229
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - add a title for the document; - add markups for section titles; - move authorship to the beginning and use :Author:; - use right markup for tables; - mark literals and literal blocks. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * preempt-locking.txt: standardize document formatMauro Carvalho Chehab2017-07-141-15/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark titles; - mark literal blocks; - adjust identation where needed; - use :Author: for authorship. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * pnp.txt: standardize document formatMauro Carvalho Chehab2017-07-141-151/+192
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Use a markup for document title; - use :Author: and :Last updated: for authorship; - adjust whitespaces where needed; - mark literal blocks; - fix a few subtitle markups. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * pi-futex.txt: standardize document formatMauro Carvalho Chehab2017-07-141-7/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx. This document requires just minor adjustments to match the standard documentation style: - promote document name; - remove extra collons on some chapter titles; - use "-" for a bulleted list. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * phy.txt: standardize document formatMauro Carvalho Chehab2017-07-141-39/+67
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark titles; - use :Author: for authorship; - mark literal blocks. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * percpu-rw-semaphore.txt: standardize document formatMauro Carvalho Chehab2017-07-141-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: This document is already adopting the standard format, with a single exception: we're using this convention for the document title: === foo === So, adjust the title of this document to follow the standard. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * parport-lowlevel.txt: standardize document formatMauro Carvalho Chehab2017-07-141-480/+841
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. This one uses a man-page like approach. Change its representation to be closer to the adopted standard, using ReST markups for it to be parseable by Sphinx: - Mark titles; - Mark literals and literal blocks; - Adjust identation. Still, the best would be to move its contents to kernel-docs. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * padata.txt: standardize document formatMauro Carvalho Chehab2017-07-141-12/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark document title; - mark literal blocks. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * numastat.txt: standardize document formatMauro Carvalho Chehab2017-07-141-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark the document title; - mark the table as such. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * ntb.txt: standardize document formatMauro Carvalho Chehab2017-07-141-18/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx. This file is using some other markup notation (likely, markdown). Convert it to the adopted standard: - Adjust the header level markup; - Adjust identation for debugfs files and module parameters. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * nommu-mmap.txt: don't use all upper case on titlesMauro Carvalho Chehab2017-07-141-9/+9
| | | | | | | | | | | | | | | | | | | | | | | | This file is almost in the standard format we're adopting for other documentation text files. Yet, it use upper case on titles. So, in order to uniform how chapter names, adjust caps on titles. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * nommu-mmap.txt: standardize document formatMauro Carvalho Chehab2017-07-141-30/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Adjust identation for main title; - fix level for chapter titles; - use ".. important::" tag for an important note; - use the right notation for paragraph auto-numbering "(#)"; - Fix footnotes syntax; - fix one literal var to use the right ReST tag. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * men-chameleon-bus.txt: standardize document formatMauro Carvalho Chehab2017-07-141-159/+171
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Adjust identations; - Remove title numbering; - mark literal blocks; - comment its TOC. Acked-by: Johannes Thumshirn <jthumshirn@suse.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * memory-hotplug.txt: standardize document formatMauro Carvalho Chehab2017-07-141-161/+194
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - use :Created: and :Updated: for the timestamps; - comment its internal index; - adjust titles and use proper markup; - Whitespace fixes; - Use cross references where needed; - Use bulleted lists where needed; - mark literal blocks; - Use the ReST notation for a table. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * mailbox.txt: standardize document formatMauro Carvalho Chehab2017-07-141-88/+97
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Add markups for section titles; - Use :Author: for authorship; - Mark literal block as such and ident it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * lzo.txt: standardize document formatMauro Carvalho Chehab2017-07-141-10/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Add markups for section titles; - mark literal blocks; - use ".. important::" for an important note. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * lockup-watchdogs.txt: standardize document formatMauro Carvalho Chehab2017-07-141-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx. This file is almost at ReST format. Just one title needs to be adjusted, in order to follow the standard. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * ldm.txt: standardize document formatMauro Carvalho Chehab2017-07-141-22/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Reformat its title; - Use :Author: and :Last Updated: for authorship - Use note markup; - Reformat table to match ReST standard; - Use bulleted lists where needed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * kref.txt: standardize document formatMauro Carvalho Chehab2017-07-141-140/+155
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - add a title for the document and section titles; - move authorship information to the beginning and use :Author: - mark literal blocks as such and ident them if needed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-17 08:35:13 +0100