summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* docs/features: parisc implements tracehookJames Hogan2017-08-071-1/+1
| | | | | | | | | | | | Since commit 64e2a42bca12 ("parisc: Add ARCH_TRACEHOOK and regset support") in v4.7, parisc selects HAVE_ARCH_TRACEHOOK, so update its entry in Documentation/features from TODO to ok. Signed-off-by: James Hogan <james.hogan@imgtec.com> Cc: "James E.J. Bottomley" <jejb@parisc-linux.org> Cc: Helge Deller <deller@gmx.de> Cc: Ingo Molnar <mingo@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: submitting-patches - change non-ascii character to asciiFrank Rowand2017-07-241-1/+1
| | | | | | | | Documentation/process/submitting-patches.rst contains a non-ascii character. Change it to the ascii equivalent. Signed-off-by: Frank Rowand <frank.rowand@sony.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'warning-fixes' into docs-nextJonathan Corbet2017-07-245-17/+3
|\ | | | | | | A series to clean up a number of docs build warnings. More to come.
| * docs: Use :internal: for include/drm/drm_syncobj.hJonathan Corbet2017-07-241-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Documentation/gpu/drm-mm.rst includes from include/drm/drm_syncobj.h with :export:, but this is a header file without export directives. That results in this warning: ./include/drm/drm_syncobj.h:1: warning: no structured comments found ...and a failure to obtain the documentation from that file. Switch to :internal: instead to make both problems go away. Cc: dri-devel@lists.freedesktop.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Do not include from drivers/scsi/constants.cJonathan Corbet2017-07-171-8/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | The only function of interest in that file was scsi_print_status(). That function was removed in commit 7ac7076344d9 (scsi: remove scsi_print_status()) but the docs were not changed to match, yielding this warning: ./drivers/scsi/constants.c:1: warning: no structured comments found There's nothing there anymore, so just remove that section from the docs. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Get the struct cmbdata kernel doc from the right fileJonathan Corbet2017-07-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Back in 2012, commit 9807f75955ea (UAPI: (Scripted) Disintegrate arch/s390/include/asm) moved struct cmbdata (and its kerneldoc comments) to another file, but did not update the docs to match. The result is this warning: ./arch/s390/include/asm/cmb.h:1: warning: no structured comments found ...and no documentation for that structure. Update the docs to get the information from the right place. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Do not include from .../seqno-fence.cJonathan Corbet2017-07-171-3/+0
| | | | | | | | | | | | | | | | | | | | There are no kerneldoc comments in drivers/dma-buf/seqno-fence.c, and it appears there never have been. Stop looking for comments there to eliminate this warning: ./drivers/dma-buf/seqno-fence.c:1: warning: no structured comments found Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Do not include kerneldoc comments from kernel/sys.cJonathan Corbet2017-07-171-3/+0
| | | | | | | | | | | | | | | | | | | | | | ...because there are none there, and I cannot figure out what would ever have been of interest there. This eliminates this warning: ./kernel/sys.c:1: warning: no structured comments found from the build. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Get module_init() docs from module.hJonathan Corbet2017-07-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | The docs build complains: ./include/linux/init.h:1: warning: no structured comments found The problem is that the comments in question were moved to module.h in commit 0fd972a7d91d (module: relocate module_init from init.h to module.h). Fix basics.rst to match. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Merge branch 'install' into docs-nextJonathan Corbet2017-07-246-17/+627
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Mauro says: Sphinx installation is not trivial, as not all versions are supported, and it requires a lot of stuff for math, images and PDF/LaTeX output to work. So, add a script that checks if everything is fine, providing distro-specific hints about what's needed for it to work.
| * | sphinx-pre-install: add support for MageiaMauro Carvalho Chehab2017-07-241-1/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add support for detecting and installing missing packages on Mageia. I opted to use "urpmi" at the install instructions, as this is present on Mageia since ever. Yet, if I were using Mageia 6, I would likely be using "dnf", as it is, IMHO, easier to use. Tested with Mageia 6. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | sphinx.rst: document scripts/sphinx-pre-install scriptMauro Carvalho Chehab2017-07-231-4/+44
| | | | | | | | | | | | | | | | | | | | | | | | Now that we have a script to check for Sphinx dependencies, document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | sphinx-pre-install: fix USE needs for GraphViz and ImageMagickMauro Carvalho Chehab2017-07-231-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Gentoo need some USE for GraphViz and ImageMagick to have the features required by kfigure.py. Output that when providing instructions for Gentoo. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | sphinx-pre-install: add dependencies for ImageMagick to work with svgMauro Carvalho Chehab2017-07-231-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ImageMagick actually uses librsvg for conversions when converiting from SVG (actually, it uses rsvg-convert). That causes the build to fail with: WARNING: Error #1 when calling: /usr/bin/convert /home/mchehab/docs/Documentation/media/uapi/v4l/selection.svg /home/mchehab/docs/Documentation/output/latex/selection.pdf convert: delegate failed `'rsvg-convert' -o '%o' '%i'' @ error/delegate.c/InvokeDelegate/1919. convert: unable to open file `/tmp/magick-8883oOQfHzrA5trM': No such file or directory @ error/constitute.c/ReadImage/544. Add the corresponding dependencies. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | sphinx-pre-install: check for the need of graphviz-gdMauro Carvalho Chehab2017-07-231-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | On newer versions of graphviz packaging on Fedora, it is needed to install a separate package for PDF support. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | sphinx-pre-install: use a requirements fileMauro Carvalho Chehab2017-07-232-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Instead of using 3 commands to install a virtualenv, use a single one, reading the requirements from this file: Documentation/sphinx/requirements.txt Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | sphinx-pre-install: detect an existing virtualenvMauro Carvalho Chehab2017-07-231-10/+18
| | | | | | | | | | | | | | | | | | | | | | | | Detect if the script runs after creating the virtualenv, printing the command line commands to enable the virtualenv. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | scripts/sphinx-pre-install: add a script to check Sphinx installMauro Carvalho Chehab2017-07-231-0/+517
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Solving Sphinx dependencies can be painful. Add a script to check if everything is ok. Tested on: - Fedora 25 and 26; - Ubuntu 17.04; - OpenSuse Tumbleweed; - Arch Linux; - Gentoo. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs: Makefile: remove no-ops targetsMauro Carvalho Chehab2017-07-233-13/+1
|/ / | | | | | | | | | | | | | | After removal of DocBook, those targets are bogus. Reported-by: Jim Davis <jim.epost@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: disable KASLR when debugging kernelZhouyi Zhou2017-07-171-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | commit 6807c84652b0 ("x86: Enable KASLR by default") enables KASLR by default on x86. While KASLR will confuse gdb which resolve kernel symbol address from symbol table of vmlinux. We should turn off KASLR for kernel debugging. Signed-off-by: Zhouyi Zhou <zhouzhouyi@gmail.com> Reviewed-by: Kieran Bingham <kbingham@kernel.org> Acked-by: Jan Kiszka <jan.kiszka@siemens.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: disable KASLR when debugging kernelZhouyi Zhou2017-07-171-1/+10
| | | | | | | | | | | | | | | | | | | | commit 6807c84652b0 ("x86: Enable KASLR by default") enables KASLR by default on x86. While KASLR will confuse gdb which resolve kernel symbol address from symbol table of vmlinux. We should turn off KASLR for kernel debugging. Signed-off-by: Zhouyi Zhou <zhouzhouyi@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs RTD theme: code-block with line nos - lines and line numbers don't line up.Markus Heiser2017-07-171-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | In a code-block with line numbers (option :lineno:) there is a misalignment of the rendered source code lines on the right side and the line numbers on the left side. https://github.com/rtfd/sphinx_rtd_theme/issues/419 Since this issue is reported to the RTD theme project, it might be fixed in the future (take this as a interim solution). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs RDT theme: fix bottom margin of lists itemsMarkus Heiser2017-07-171-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | List items with two ore more blocks are not well rendered. E.g. the gap between last block (l1-b2) of the first list item and the following list item (L2) is to small:: * L1 xxxxxxxxxx xxxxxxxxxxxxx l1-b2 xxxxxxx xxxxxxxxxxxxx * L2 xxxxxxxxxx xxxxxxxxxxxxx So that it can be read more liquidly, a distance was added to the last block (l1-b2):: * L1 xxxxxxxxxx xxxxxxxxxxxxx l1-b2 xxxxxxx xxxxxxxxxxxxx * L2 xxxxxxxxxx xxxxxxxxxxxxx Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Documentation: arm: Replace use of virt_to_phys with __pa_symbolGeert Uytterhoeven2017-07-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | All low-level PM/SMP code using virt_to_phys() should actually use __pa_symbol() against kernel symbols. Update the documentation to move away from virt_to_phys(). Cfr. commit 6996cbb2372189f7 ("ARM: 8641/1: treewide: Replace uses of virt_to_phys with __pa_symbol") Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | sphinx.rst: better organize the documentation about PDF buildMauro Carvalho Chehab2017-07-171-8/+13
| | | | | | | | | | | | | | | | | | | | Instead of having it on just one note, add a separate section. This way, we could later improve it, providing a better guide about the needed steps for PDF builds. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | sphinx.rst: describe the install requirements for kfigureMauro Carvalho Chehab2017-07-171-0/+13
| | | | | | | | | | | | | | | | | | As we now have a document describing the install requirements for Sphinx, add there the need for GraphViz and ImageMagick. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | sphinx.rst: fix unknown referenceMauro Carvalho Chehab2017-07-171-1/+1
| | | | | | | | | | | | | | | | There's no "Sphinx C Domain" reference at the Kernel documentation. So, don't use references for it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | sphinx.rst: explain the usage of virtual environmentMauro Carvalho Chehab2017-07-171-0/+32
| | | | | | | | | | | | | | | | | | As the Sphinx build seems very fragile, specially for PDF output, add a notice about how to use it on a virtual environment. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: move Sphinx install instructions to sphinx.rstMauro Carvalho Chehab2017-07-172-12/+19
| | | | | | | | | | | | | | | | | | | | The toolchain used by Sphinx is somewhat complex, and installing it should be part of the doc-guide. Move it out of changes.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | changes.rst: Update Sphinx minimal requirementsMauro Carvalho Chehab2017-07-171-3/+3
|/ | | | | | | | The kfigure module doesn't work with Sphinx version 1.2. So, update the minimal requirements accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-09 01:10:37 +0100