platform/kernel/linux-rpi.git
4 years agodocs: hw-vuln: tsx_async_abort.rst: get rid of an unused ref
Mauro Carvalho Chehab [Tue, 3 Mar 2020 15:50:39 +0000 (16:50 +0100)]
docs: hw-vuln: tsx_async_abort.rst: get rid of an unused ref

The virt_mechanism reference there points to a section
called elsewhere (Virtualization mitigation). Also, it is
not used anywere.

Besides that, it conflicts with a label with the same name
inside:

Documentation/admin-guide/hw-vuln/mds.rst

Perhaps added due to some cut-and-paste?

Anyway, as this is not used, let's just get rid of it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/681c8e2916bf4943ac2277f181668bfbc5fdbc01.1583250595.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: perf: imx-ddr.rst: get rid of a warning
Mauro Carvalho Chehab [Tue, 3 Mar 2020 15:50:38 +0000 (16:50 +0100)]
docs: perf: imx-ddr.rst: get rid of a warning

    Documentation/admin-guide/perf/imx-ddr.rst:47: WARNING: Unexpected indentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/b27b54bd4f847032fd33313d6497ff320c0f3d78.1583250595.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: fuse.rst: supress a Sphinx warning
Mauro Carvalho Chehab [Tue, 3 Mar 2020 15:50:37 +0000 (16:50 +0100)]
docs: filesystems: fuse.rst: supress a Sphinx warning

Get rid of this warning:

    Documentation/filesystems/fuse.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.

Fixes: 8ab13bca428b ("Documentation: filesystems: convert fuse to RST")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/cad541ec7d8d220d57bd5d097d60c62da64054ac.1583250595.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: translations: it: avoid duplicate refs at programming-language.rst
Mauro Carvalho Chehab [Tue, 3 Mar 2020 15:50:36 +0000 (16:50 +0100)]
docs: translations: it: avoid duplicate refs at programming-language.rst

As the translations document is part of the main body, we can't
keep duplicated references there. So, prefix the Italian ones
with "it-".

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/e733111f3599dff96524ad09ace5204ac6bb496b.1583250595.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: driver.rst: supress two ReSt warnings
Mauro Carvalho Chehab [Tue, 3 Mar 2020 15:50:34 +0000 (16:50 +0100)]
docs: driver.rst: supress two ReSt warnings

Get rid of those, by marking a literal block as such:

Documentation/driver-api/gpio/driver.rst:425: WARNING: Unexpected indentation.
Documentation/driver-api/gpio/driver.rst:423: WARNING: Inline emphasis start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/8356b02547087979f57cb71fbefb5e5f636c78f4.1583250595.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: trace: events.rst: convert some new stuff to ReST format
Mauro Carvalho Chehab [Tue, 3 Mar 2020 15:50:31 +0000 (16:50 +0100)]
docs: trace: events.rst: convert some new stuff to ReST format

Some new chapters were added to the documentation. This caused
Sphinx to complain, as the literal blocks there are not properly
tagged as such. Also, a new note added there doesn't follow
the ReST format.

This fixes the following warnings:

    Documentation/trace/events.rst:589: WARNING: Definition list ends without a blank line; unexpected unindent.
    Documentation/trace/events.rst:620: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:623: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:626: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:703: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:697: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:722: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:775: WARNING: Definition list ends without a blank line; unexpected unindent.
    Documentation/trace/events.rst:814: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:817: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:820: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:823: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:826: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:829: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:832: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:844: WARNING: Unexpected indentation.
    Documentation/trace/events.rst:845: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/trace/events.rst:849: WARNING: Unexpected indentation.
    Documentation/trace/events.rst:850: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/trace/events.rst:883: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:886: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:889: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:895: WARNING: Bullet list ends without a blank line; unexpected unindent.
    Documentation/trace/events.rst:895: WARNING: Inline emphasis start-string without end-string.
    Documentation/trace/events.rst:968: WARNING: Inline emphasis start-string without end-string.

Fixes: 34ed63573b66 ("tracing: Documentation for in-kernel synthetic event API")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Tom Zanussi <zanussi@kernel.org>
Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Link: https://lore.kernel.org/r/afbe367ccb7b9abcb9fab7bc5cb5e0686c105a53.1583250595.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: Add io_ordering.rst to driver-api manual
Pragat Pandya [Tue, 3 Mar 2020 05:03:01 +0000 (10:33 +0530)]
Documentation: Add io_ordering.rst to driver-api manual

Add io_ordering.rst under Documentation/driver-api and reference it from
the Sphinx TOC Tree present in Documentation/driver-api/index.rst

Signed-off-by: Pragat Pandya <pragat.pandya@gmail.com>
Link: https://lore.kernel.org/r/20200303050301.5412-3-pragat.pandya@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: Add io-mapping.rst to driver-api manual
Pragat Pandya [Tue, 3 Mar 2020 05:03:00 +0000 (10:33 +0530)]
Documentation: Add io-mapping.rst to driver-api manual

Add io-mapping.rst under Documentation/driver-api and reference it from
Sphinx TOC Tree present in Documentation/driver-api/index.rst

Signed-off-by: Pragat Pandya <pragat.pandya@gmail.com>
Link: https://lore.kernel.org/r/20200303050301.5412-2-pragat.pandya@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: management-style: Fix formatting of emphsized word
Jonathan Neuschäfer [Tue, 3 Mar 2020 19:21:12 +0000 (20:21 +0100)]
Documentation: management-style: Fix formatting of emphsized word

Commit 7f2b3c65b9a1 ("Documentation/ManagementStyle: convert it to ReST
markup") converted _underlined_ to *emphasized* words, but forgot about
an underscore in this case.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20200303192113.20761-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: dev-tools: kmemleak: Update list of architectures
Jonathan Neuschäfer [Tue, 3 Mar 2020 19:42:15 +0000 (20:42 +0100)]
docs: dev-tools: kmemleak: Update list of architectures

* Don't list powerpc twice (once as ppc)
* Drop tile, which has been removed from the source tree
* Mention arm64, nds32, arc, and xtensa

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20200303194215.23756-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoMAINTAINERS: adjust to kobject doc ReST conversion
Lukas Bulwahn [Wed, 4 Mar 2020 11:08:21 +0000 (12:08 +0100)]
MAINTAINERS: adjust to kobject doc ReST conversion

Commit 5fed00dcaca8 ("Documentation: kobject.txt has been moved to
core-api/kobject.rst") missed to adjust the entry in MAINTAINERS.

Since then, ./scripts/get_maintainer.pl --self-test complains:

  warning: no file matches F: Documentation/kobject.txt

Adjust DRIVER CORE, KOBJECTS, DEBUGFS AND SYSFS entry in MAINTAINERS.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20200304110821.7243-1-lukas.bulwahn@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: Remove :c:func: from process/deprecated.rst
Jonathan Corbet [Tue, 10 Mar 2020 17:27:22 +0000 (11:27 -0600)]
docs: Remove :c:func: from process/deprecated.rst

Documentation/process/deprecated.rst has a lot of uses of :c:func:, which
is, well, deprecated.  Emacs query-replace-regexp to the rescue.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: deprecated.rst: Clean up fall-through details
Kees Cook [Wed, 4 Mar 2020 19:03:24 +0000 (11:03 -0800)]
docs: deprecated.rst: Clean up fall-through details

Add example of fall-through, list-ify the case ending statements, and
adjust the markup for links and readability. While here, adjust
strscpy() details to mention strscpy_pad().

Signed-off-by: Kees Cook <keescook@chromium.org>
Acked-by: Gustavo A. R. Silva <gustavo@embeddedor.com>
Link: https://lore.kernel.org/r/202003041102.47A4E4B62@keescook
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: move core-api/ioctl.rst to driver-api/
Jonathan Corbet [Mon, 2 Mar 2020 22:26:38 +0000 (15:26 -0700)]
docs: move core-api/ioctl.rst to driver-api/

The ioctl() documentation belongs with the rest of the driver-oriented
info, so move it there.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: move gcc-plugins to the kbuild manual
Jonathan Corbet [Mon, 2 Mar 2020 22:24:04 +0000 (15:24 -0700)]
docs: move gcc-plugins to the kbuild manual

Information about GCC plugins is relevant to kernel building, so move this
document to the kbuild manual.

Acked-by: Masahiro Yamada <masahiroy@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: Organize core-api/index.rst
Jonathan Corbet [Mon, 2 Mar 2020 22:17:17 +0000 (15:17 -0700)]
docs: Organize core-api/index.rst

The core-api manual has become a big, disorganized mess.  Try to bring a
small amount of order to it by organizing the documents into
subcategories.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: deprecated.rst: Add %p to the list
Kees Cook [Thu, 5 Mar 2020 07:03:47 +0000 (23:03 -0800)]
docs: deprecated.rst: Add %p to the list

Once in a while %p usage comes up, and I've needed to have a reference
to point people to. Add %p details to deprecated.rst.

Signed-off-by: Kees Cook <keescook@chromium.org>
Link: https://lore.kernel.org/r/202003042301.F844A8C0EC@keescook
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: it_IT: netdev-FAQ: Fix link to original document
Jonathan Neuschäfer [Thu, 5 Mar 2020 20:51:21 +0000 (21:51 +0100)]
docs: it_IT: netdev-FAQ: Fix link to original document

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20200305205123.8569-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: admin-guide: binfmt-misc: Improve the title
Jonathan Neuschäfer [Sun, 8 Mar 2020 21:09:34 +0000 (22:09 +0100)]
docs: admin-guide: binfmt-misc: Improve the title

Trim the title a bit, since it's relatively long. Add `binfmt_misc` to
make it easier to search for the feature by its common name.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20200308210935.7273-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: Move Intel Many Integrated Core documentation (mic) under misc-devices
Jonathan Neuschäfer [Sun, 8 Mar 2020 21:14:43 +0000 (22:14 +0100)]
docs: Move Intel Many Integrated Core documentation (mic) under misc-devices

It doesn't need to be a top-level chapter.

This patch also updates MAINTAINERS and makes sure the F: lines are
properly sorted.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Link: https://lore.kernel.org/r/20200308211519.8414-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoMerge branch 'mauro' into docs-next
Jonathan Corbet [Mon, 2 Mar 2020 21:11:43 +0000 (14:11 -0700)]
Merge branch 'mauro' into docs-next

Mauro sez:

  There are lots of plain text documents under Documentation/filesystems.
  Manually convert several of those to ReST and add them to the index file.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert zonefs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:30 +0000 (17:12 +0100)]
docs: filesystems: convert zonefs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Damien Le Moal <damien.lemoal@wdc.com>
Link: https://lore.kernel.org/r/42a7cfcd19f6b904a9a3188fd4af71bed5050052.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert udf.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:29 +0000 (17:12 +0100)]
docs: filesystems: convert udf.txt to ReST

- Add a SPDX header;
- Add a document title;
- Add table markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/2887f8a3a813a31170389eab687e9f199327dc7d.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ubifs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:28 +0000 (17:12 +0100)]
docs: filesystems: convert ubifs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Adjust section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/9043dc2965cafc64e6a521e2317c00ecc8303bf6.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ubifs-authentication.rst.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:27 +0000 (17:12 +0100)]
docs: filesystems: convert ubifs-authentication.rst.txt to ReST

- Add a SPDX header;
- Mark some literals as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/0c36091b6660cd372f994bd98e1264491d766c22.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert tmpfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:26 +0000 (17:12 +0100)]
docs: filesystems: convert tmpfs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Use :field: markup;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/30397a47a78ca59760fbc0fc5f50c5f1002d487a.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert sysv-fs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:25 +0000 (17:12 +0100)]
docs: filesystems: convert sysv-fs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5b96a6efba95773af439ab25a7dbe4d0edf8c867.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert sysfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:24 +0000 (17:12 +0100)]
docs: filesystems: convert sysfs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Adjust document and section titles;
- use :field: markup;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5c480dcb467315b5df6e25372a65e473b585c36d.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert squashfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:23 +0000 (17:12 +0100)]
docs: filesystems: convert squashfs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/cec30862c7ee7de7f9cd903e35e6c8bf74cc928a.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert romfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:22 +0000 (17:12 +0100)]
docs: filesystems: convert romfs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/d2cc83e7cd6de63c793ccd3f2588ea40f7f1e764.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert relay.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:21 +0000 (17:12 +0100)]
docs: filesystems: convert relay.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Use notes markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/f48bb0fdf64d197f28c6f469adb61a7a091adb75.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ramfs-rootfs-initramfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:20 +0000 (17:12 +0100)]
docs: filesystems: convert ramfs-rootfs-initramfs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Use notes markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/89cbcc99a6371f3bff3ea1668fe497e8a15c226b.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert qnx6.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:19 +0000 (17:12 +0100)]
docs: filesystems: convert qnx6.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/ccd22c1e1426ce4cb30ece9a71c39ebb41844762.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert proc.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:18 +0000 (17:12 +0100)]
docs: filesystems: convert proc.txt to ReST

This document has a nice format! Unfortunately, not exactly
ReST. So, several adjustments were required:

- Add a SPDX header;
- Adjust document and section titles;
- Whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add table captions;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/1d113d860188de416ca3b0b97371dc2195433d5b.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert orangefs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:17 +0000 (17:12 +0100)]
docs: filesystems: convert orangefs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/6f438eeff5b029d229197a602bd9b74004fe9b63.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert omfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:16 +0000 (17:12 +0100)]
docs: filesystems: convert omfs.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Bob Copeland <me@bobcopeland.com>
Link: https://lore.kernel.org/r/0c125c7c971d81a557ca954992b8d770a9d1e3e8.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ocfs2.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:15 +0000 (17:12 +0100)]
docs: filesystems: convert ocfs2.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Joseph Qi <joseph.qi@linux.alibaba.com>
Link: https://lore.kernel.org/r/e29a8120bf1d847f23fb68e915f10a7d43bed9e3.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ocfs2-online-filecheck.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:14 +0000 (17:12 +0100)]
docs: filesystems: convert ocfs2-online-filecheck.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/6007166acc3252697755836354bd29b5a5fb82aa.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ntfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:13 +0000 (17:12 +0100)]
docs: filesystems: convert ntfs.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Comment out text-only ToC;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/f09ca6c9bdd4e7aa7208f3dba0b8753080b38d03.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert nilfs2.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:12 +0000 (17:12 +0100)]
docs: filesystems: convert nilfs2.txt to ReST

- Add a SPDX header;
- Add a document title;
- Adjust document title;
- Mark literal blocks as such;
- use :field: markup;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/f7989ca501585f5990fffd2d365cfca4fe9fdd6f.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert isofs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:11 +0000 (17:12 +0100)]
docs: filesystems: convert isofs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Add table markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/ec16dc09d0c23bb0c1af3d3f33a96896083a1d36.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert inotify.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:10 +0000 (17:12 +0100)]
docs: filesystems: convert inotify.txt to ReST

- Add a SPDX header;
- Add a document title;
- Adjust document title;
- Fix list markups;
- Some whitespace fixes and new line breaks;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/8f846843ecf1914988feb4d001e3a53d27dc1a65.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert hpfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:09 +0000 (17:12 +0100)]
docs: filesystems: convert hpfs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/581019c3120938118aa55ba28902b62083c3f37a.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert hfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:08 +0000 (17:12 +0100)]
docs: filesystems: convert hfs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Use notes markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/8a625d6652d88809730020048d26c3b9333ddbdf.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert hfsplus.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:07 +0000 (17:12 +0100)]
docs: filesystems: convert hfsplus.txt to ReST

Just trivial changes:

- Add a SPDX header;
- Add it to filesystems/index.rst.

While here, adjust document title, just to make it use the same
style of the other docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/4298409da951fbee000201a6c8d9c85e961b2b79.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert gfs2-uevents.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:06 +0000 (17:12 +0100)]
docs: filesystems: convert gfs2-uevents.txt to ReST

This document is almost in ReST format: all it needs is to have
the titles adjusted and add a SPDX header. In other words:

- Add a SPDX header;
- Add a document title;
- Adjust section titles;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Bob Peterson <rpeterso@redhat.com>
Link: https://lore.kernel.org/r/1d1c46b7e86bd0a18d9abbea0de0bc2be84e5e2b.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert gfs2.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:05 +0000 (17:12 +0100)]
docs: filesystems: convert gfs2.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Bob Peterson <rpeterso@redhat.com>
Link: https://lore.kernel.org/r/6d7a296de025bcfed7a229da7f8cc1678944f304.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert f2fs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:04 +0000 (17:12 +0100)]
docs: filesystems: convert f2fs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/8dd156320b0c015dec6d3f848d03ea057042a15b.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ext3.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:03 +0000 (17:12 +0100)]
docs: filesystems: convert ext3.txt to ReST

Nothing really required here. Just renaming would be enough.

Yet, while here, lets add a SPDX header and adjust document title
to met the same standard we're using on most docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/26960235e3e7c972bd543f5dd59f1ef4f3a877c6.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ext2.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:02 +0000 (17:12 +0100)]
docs: filesystems: convert ext2.txt to ReST

- Add a SPDX header;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Use footnoote markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/fde6721f0303259d830391e351dbde48f67f3ec7.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert erofs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:01 +0000 (17:12 +0100)]
docs: filesystems: convert erofs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/402d1d2f7252b8a683f7a9c6867bc5428da64026.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert efivarfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:12:00 +0000 (17:12 +0100)]
docs: filesystems: convert efivarfs.txt to ReST

Trivial changes:

- Add a SPDX header;
- Adjust document title;
- Mark a literal block as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/215691d747055c4ccb038ec7d78d8d1fe87fe2c0.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ecryptfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:59 +0000 (17:11 +0100)]
docs: filesystems: convert ecryptfs.txt to ReST

- Add a SPDX header;
- Add a document title;
- use :field: markup;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Tyler Hicks <code@tyhicks.com>
Link: https://lore.kernel.org/r/6e13841ebd00c8d988027115c75c58821bb41a0c.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert dlmfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:58 +0000 (17:11 +0100)]
docs: filesystems: convert dlmfs.txt to ReST

- Add a SPDX header;
- Use copyright symbol;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/efc9e59925723e17d1a4741b11049616c221463e.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert debugfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:57 +0000 (17:11 +0100)]
docs: filesystems: convert debugfs.txt to ReST

- Add a SPDX header;
- Use copyright symbol;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Use footnoote markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/42db8f9db17a5d8b619130815ae63d1615951d50.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert cramfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:56 +0000 (17:11 +0100)]
docs: filesystems: convert cramfs.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Nicolas Pitre <nico@fluxnic.net>
Link: https://lore.kernel.org/r/e87b267e71f99974b7bb3fc0a4a08454ff58165e.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert ceph.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:55 +0000 (17:11 +0100)]
docs: filesystems: convert ceph.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jeff Layton <jlayton@kernel.org>
Link: https://lore.kernel.org/r/df2f142b5ca5842e030d8209482dfd62dcbe020f.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert btrfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:54 +0000 (17:11 +0100)]
docs: filesystems: convert btrfs.txt to ReST

Just trivial changes:

- Add a SPDX header;
- Add it to filesystems/index.rst.

While here, adjust document title, just to make it use the same
style of the other docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: David Sterba <dsterba@suse.com>
Link: https://lore.kernel.org/r/1ef76da4ac24a9a6f6187723554733c702ea19ae.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert bfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:53 +0000 (17:11 +0100)]
docs: filesystems: convert bfs.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/93991bcc05e419368ee1e585c81057fb2c7c8d2b.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert befs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:52 +0000 (17:11 +0100)]
docs: filesystems: convert befs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/3e29ea6df6cd569021cfa953ccb8ed7dfc146f3d.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert autofs-mount-control.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:51 +0000 (17:11 +0100)]
docs: filesystems: convert autofs-mount-control.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/8cae057ae244d0f5b58d3c209bcdae5ed82bc52c.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert afs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:50 +0000 (17:11 +0100)]
docs: filesystems: convert afs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Comment out text-only ToC;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/d77f5afdb5da0f8b0ec3dbe720aef23f1ce73bb5.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert affs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:49 +0000 (17:11 +0100)]
docs: filesystems: convert affs.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Add table markups;
- Mark literal blocks as such;
- Some whitespace fixes and new line breaks;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: David Sterba <dsterba@suse.com>
Link: https://lore.kernel.org/r/b44c56befe0e28cbc0eb1b3e281ad7d99737ff16.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert adfs.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:48 +0000 (17:11 +0100)]
docs: filesystems: convert adfs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Adjust section titles;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/15ee92f03ec917e5d26bd7b863565dec88c843f6.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: filesystems: convert 9p.txt to ReST
Mauro Carvalho Chehab [Mon, 17 Feb 2020 16:11:47 +0000 (17:11 +0100)]
docs: filesystems: convert 9p.txt to ReST

- Add a SPDX header;
- Add a document title;
- Adjust section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/96a060b7b5c0c3838ab1751addfe4d6d3bc37bd6.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: nfsroot.rst: Fix references to nfsroot.rst
Niklas Söderlund [Wed, 12 Feb 2020 18:13:32 +0000 (19:13 +0100)]
Documentation: nfsroot.rst: Fix references to nfsroot.rst

When converting and moving nfsroot.txt to nfsroot.rst the references to
the old text file was not updated to match the change, fix this.

Fixes: f9a9349846f92b2d ("Documentation: nfsroot.txt: convert to ReST")
Signed-off-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>
Link: https://lore.kernel.org/r/20200212181332.520545-1-niklas.soderlund+renesas@ragnatech.se
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoscripts/sphinx-pre-install: add '-p python3' to virtualenv
Tim Bird [Tue, 25 Feb 2020 01:34:41 +0000 (18:34 -0700)]
scripts/sphinx-pre-install: add '-p python3' to virtualenv

With Ubuntu 16.04 (and presumably Debian distros of the same age),
the instructions for setting up a python virtual environment should
do so with the python 3 interpreter.  On these older distros, the
default python (and virtualenv command) might be python2 based.

Some of the packages that sphinx relies on are now only available
for python3.  If you don't specify the python3 interpreter for
the virtualenv, you get errors when doing the pip installs for
various packages

Fix this by adding '-p python3' to the virtualenv recommendation
line.

Signed-off-by: Tim Bird <tim.bird@sony.com>
Link: https://lore.kernel.org/r/1582594481-23221-1-git-send-email-tim.bird@sony.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: kthread: Fix WQ_SYSFS workqueues path name
Zenghui Yu [Tue, 25 Feb 2020 12:40:52 +0000 (20:40 +0800)]
Documentation: kthread: Fix WQ_SYSFS workqueues path name

The set of WQ_SYSFS workqueues should be displayed using
"ls /sys/devices/virtual/workqueue", add the missing '/'.

Signed-off-by: Zenghui Yu <yuzenghui@huawei.com>
Link: https://lore.kernel.org/r/20200225124052.1506-1-yuzenghui@huawei.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: kobject.txt has been moved to core-api/kobject.rst
Sameer Rahmani [Tue, 25 Feb 2020 22:21:25 +0000 (22:21 +0000)]
Documentation: kobject.txt has been moved to core-api/kobject.rst

Moved the `kobject.txt` to `core-api/kobject.rst` and updated the
`core-api` index to point to it.

Signed-off-by: Sameer Rahmani <lxsameer@gnu.org>
[jc: moved it down from the top of core-api/index.rst]
Link: https://lore.kernel.org/r/20200225222125.61874-2-lxsameer@gnu.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: Converted the `kobject.txt` to rst format
Sameer Rahmani [Tue, 25 Feb 2020 22:21:24 +0000 (22:21 +0000)]
Documentation: Converted the `kobject.txt` to rst format

Reviewed and converted the `kobject.txt` format to rst in place.

Signed-off-by: Sameer Rahmani <lxsameer@gnu.org>
Link: https://lore.kernel.org/r/20200225222125.61874-1-lxsameer@gnu.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodoc: cgroup: improve formatting of references
Jakub Kicinski [Fri, 28 Feb 2020 00:06:53 +0000 (16:06 -0800)]
doc: cgroup: improve formatting of references

Annotate references to other documents to make them clickable.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Link: https://lore.kernel.org/r/20200228000653.1572553-6-kuba@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodoc: cgroup: improve formatting of cpuset examples
Jakub Kicinski [Fri, 28 Feb 2020 00:06:52 +0000 (16:06 -0800)]
doc: cgroup: improve formatting of cpuset examples

We need literal sections otherwise the entire example is rendered
as a single line.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Link: https://lore.kernel.org/r/20200228000653.1572553-5-kuba@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodoc: cgroup: improve formatting of io example
Jakub Kicinski [Fri, 28 Feb 2020 00:06:51 +0000 (16:06 -0800)]
doc: cgroup: improve formatting of io example

We need a literal section, like few paragraphs below.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Link: https://lore.kernel.org/r/20200228000653.1572553-4-kuba@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodoc: cgroup: improve formatting of mem stats
Jakub Kicinski [Fri, 28 Feb 2020 00:06:50 +0000 (16:06 -0800)]
doc: cgroup: improve formatting of mem stats

If there is an empty line between item and description
Sphinx does not emphasize the item. First half of the
list does not have the empty line and is emphasized
correctly.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Link: https://lore.kernel.org/r/20200228000653.1572553-3-kuba@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodoc: cgroup: improve formatting
Jakub Kicinski [Fri, 28 Feb 2020 00:06:49 +0000 (16:06 -0800)]
doc: cgroup: improve formatting

Fix tabs vs spaces issue which cases the line to be considered
a new list entry.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Link: https://lore.kernel.org/r/20200228000653.1572553-2-kuba@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: kernel-docs: Remove "Here is its" at the end of lines
Jonathan Neuschäfer [Fri, 28 Feb 2020 20:41:45 +0000 (21:41 +0100)]
docs: kernel-docs: Remove "Here is its" at the end of lines

Before commit 9e03ea7f683e ("Documentation/kernel-docs.txt: convert it
to ReST markup"), it read:

       Description: Linux Journal Kernel Korner article. Here is its
       abstract: "..."

In Sphinx' HTML formatting, however, the "Here is its" doesn't make
sense anymore, because the "Abstract:" is clearly separated.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20200228204147.8622-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: admin-guide: kernel-parameters: Document earlycon options for i.MX UARTs
Jonathan Neuschäfer [Sat, 29 Feb 2020 13:27:48 +0000 (14:27 +0100)]
docs: admin-guide: kernel-parameters: Document earlycon options for i.MX UARTs

drivers/tty/serial/imx.c implements these earlycon options.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20200229132750.2783-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: dev-tools: gcov: Remove a stray single-quote
Jonathan Neuschäfer [Sat, 29 Feb 2020 17:35:14 +0000 (18:35 +0100)]
docs: dev-tools: gcov: Remove a stray single-quote

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20200229173515.13868-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: kref: Clarify the use of two kref_put() in example code
Manivannan Sadhasivam [Thu, 13 Feb 2020 12:53:11 +0000 (18:23 +0530)]
docs: kref: Clarify the use of two kref_put() in example code

Eventhough the current documentation explains that the reference count
gets incremented by both kref_init() and kref_get(), it is often
misunderstood that only one instance of kref_put() is needed in the
example code. So let's clarify that a bit.

Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: add a script to check sysctl docs
Stephen Kitt [Wed, 19 Feb 2020 15:34:42 +0000 (16:34 +0100)]
docs: add a script to check sysctl docs

This script allows sysctl documentation to be checked against the
kernel source code, to identify missing or obsolete entries. Running
it against 5.5 shows for example that sysctl/kernel.rst has two
obsolete entries and is missing 52 entries.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: fix a typo for intel_iommu=nobounce
Alex Hung [Wed, 19 Feb 2020 19:21:33 +0000 (12:21 -0700)]
Documentation: fix a typo for intel_iommu=nobounce

"untrusted" was mis-spelled as "unstrusted"

Signed-off-by: Alex Hung <alex.hung@canonical.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: sysctl/kernel: document acpi_video_flags
Stephen Kitt [Fri, 21 Feb 2020 16:55:02 +0000 (17:55 +0100)]
docs: sysctl/kernel: document acpi_video_flags

Based on the implementation in arch/x86/kernel/acpi/sleep.c, in
particular the acpi_sleep_setup() function.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoMerge tag 'docs-5.6-fixes' into docs-next
Jonathan Corbet [Tue, 25 Feb 2020 10:22:29 +0000 (03:22 -0700)]
Merge tag 'docs-5.6-fixes' into docs-next

A pair of docs-build fixes.

4 years agodocs: Fix empty parallelism argument
Kees Cook [Sat, 22 Feb 2020 00:02:39 +0000 (16:02 -0800)]
docs: Fix empty parallelism argument

When there was no parallelism (no top-level -j arg and a pre-1.7
sphinx-build), the argument passed would be empty ("") instead of just
being missing, which would (understandably) badly confuse sphinx-build.
Fix this by removing the quotes.

Reported-by: Rafael J. Wysocki <rafael@kernel.org>
Fixes: 51e46c7a4007 ("docs, parallelism: Rearrange how jobserver reservations are made")
Cc: stable@vger.kernel.org # v5.5 only
Signed-off-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: remove MPX from the x86 toc
Stephen Kitt [Fri, 21 Feb 2020 20:57:33 +0000 (21:57 +0100)]
docs: remove MPX from the x86 toc

MPX was removed in commit 45fc24e89b7c ("x86/mpx: remove MPX from
arch/x86"), this removes the corresponding entry in the x86 toc.

This was suggested by a Sphinx warning.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Fixes: 45fc24e89b7cc ("x86/mpx: remove MPX from arch/x86")
Acked-by: Dave Hansen <dave.hansen@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: gpu: i915.rst: fix warnings due to file renames
Mauro Carvalho Chehab [Sat, 22 Feb 2020 09:00:07 +0000 (10:00 +0100)]
docs: gpu: i915.rst: fix warnings due to file renames

Fix two warnings due to file rename:

WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function csr support for dmc ./drivers/gpu/drm/i915/intel_csr.c' failed with return code 1
WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -internal ./drivers/gpu/drm/i915/intel_csr.c' failed with return code 2

Fixes: 06d3ff6e7451 ("drm/i915: move intel_csr.[ch] under display/")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoscripts: documentation-file-ref-check: improve :doc: handling
Mauro Carvalho Chehab [Sat, 22 Feb 2020 09:00:01 +0000 (10:00 +0100)]
scripts: documentation-file-ref-check: improve :doc: handling

There are some issues at the script with regards to :doc:
tags:

- It doesn't escape files under Documentation/sphinx,
  leading to false positives;
- It doesn't handle root URLs, like :doc:`/x86/boot`;
- It doesn't output the file with a bad reference.

Address those things, in order to remove false positives
from the list of problems.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs/core-api: Add Fedora instructions for GCC plugins
Michael Ellerman [Fri, 21 Feb 2020 00:48:43 +0000 (11:48 +1100)]
docs/core-api: Add Fedora instructions for GCC plugins

Add an example of how to install the necessary packages for GCC
plugins on Fedora.

Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
Reviewed-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agotools/edid: Move EDID data sets from Documentation/
Jonathan Neuschäfer [Fri, 14 Feb 2020 17:41:34 +0000 (18:41 +0100)]
tools/edid: Move EDID data sets from Documentation/

The EDID files are not really documentation.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: admin-guide: edid: Clarify where to run "make"
Jonathan Neuschäfer [Fri, 14 Feb 2020 17:41:35 +0000 (18:41 +0100)]
docs: admin-guide: edid: Clarify where to run "make"

When both the documentation and the data files lived in
Documentation/EDID, this wasn't necessary, but both have
been moved to other directories in the meantime.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: admin-guide: Move edid.rst from driver-api
Jonathan Neuschäfer [Fri, 14 Feb 2020 17:41:33 +0000 (18:41 +0100)]
docs: admin-guide: Move edid.rst from driver-api

This document describes actions that an admin can do, rather than
interfaces available to driver developers, so admin-guide seems to
be a more appropriate place for it.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: driver-api: edid: Fix list formatting
Jonathan Neuschäfer [Fri, 14 Feb 2020 17:41:32 +0000 (18:41 +0100)]
docs: driver-api: edid: Fix list formatting

Without the empty lines, Sphinx renders the list as part of the running
text.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: sort _SPHINXDIRS for 'make help'
Randy Dunlap [Sun, 16 Feb 2020 07:26:06 +0000 (23:26 -0800)]
Documentation: sort _SPHINXDIRS for 'make help'

Sort the _SPHINXDIRS so that the 'make help' output is easier to read &
search and in a predictable order instead of some unknown pseudo-random
order.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoDocumentation: bring process docs up to date
Tony Fischetti [Mon, 17 Feb 2020 00:08:26 +0000 (19:08 -0500)]
Documentation: bring process docs up to date

The guide to the kernel dev process documentation, for example, contains
references to older kernels and their timelines. In addition, one of the
"long term support kernels" listed have since reached EOL, and a new one
has been named. This patch brings information/tables up to date.

Additionally, some very trivial grammatical errors, unclear sentences,
and potentially unsavory diction have been edited.

Signed-off-by: Tony Fischetti <tony.fischetti@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agoReplace dead urls with active urls for Mutt
Bhaskar Chowdhury [Tue, 18 Feb 2020 09:40:13 +0000 (15:10 +0530)]
Replace dead urls with active urls for Mutt

This patch replace stale/dead urls with active urls for Mutt.

Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: sysctl/kernel: remove rtsig entries
Stephen Kitt [Tue, 18 Feb 2020 12:59:23 +0000 (13:59 +0100)]
docs: sysctl/kernel: remove rtsig entries

These have no corresponding code in the kernel.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: document panic fully in sysctl/kernel.rst
Stephen Kitt [Tue, 18 Feb 2020 12:59:21 +0000 (13:59 +0100)]
docs: document panic fully in sysctl/kernel.rst

The description of panic doesn’t cover all the supported scenarios;
this patch fixes that, describing the three possibilities (no reboot,
immediate reboot, reboot after a delay).

Based on the implementation in kernel/panic.c.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: document stop-a in sysctl/kernel.rst
Stephen Kitt [Tue, 18 Feb 2020 12:59:20 +0000 (13:59 +0100)]
docs: document stop-a in sysctl/kernel.rst

This describes the SPARC-specific stop-a sysctl entry, which was
previously listed in kernel.rst but not documented.

Base on the implementation in arch/sparc/kernel/setup_{32,64}.c and
kernel/panic.c.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: add missing IPC documentation in sysctl/kernel.rst
Stephen Kitt [Tue, 18 Feb 2020 12:59:19 +0000 (13:59 +0100)]
docs: add missing IPC documentation in sysctl/kernel.rst

This adds short descriptions of msgmax, msgmnb, msgmni, and shmmni,
which were previously listed in kernel.rst but not described.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
4 years agodocs: drop l2cr from sysctl/kernel.rst
Stephen Kitt [Tue, 18 Feb 2020 12:59:18 +0000 (13:59 +0100)]
docs: drop l2cr from sysctl/kernel.rst

The l2cr sysctl entry was removed in commit c2f3dabefa73 ("sysctl:
kill binary sysctl KERN_PPC_L2CR"), this removes the corresponding
documentation.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>