Mauro Carvalho Chehab
c33e97efa9
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 >
2020-03-02 14:04:40 -07:00
Mauro Carvalho Chehab
18ccb2233f
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 >
2020-03-02 14:04:40 -07:00
Mauro Carvalho Chehab
7cbb468f0c
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 >
2020-03-02 14:04:26 -07:00
Mauro Carvalho Chehab
fa95e087ff
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 >
2020-03-02 14:04:08 -07:00
Mauro Carvalho Chehab
3d0c60d004
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 >
2020-03-02 14:04:06 -07:00
Mauro Carvalho Chehab
461f2c8f13
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 >
2020-03-02 14:04:06 -07:00
Mauro Carvalho Chehab
2640c19dca
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 >
2020-03-02 14:04:06 -07:00
Mauro Carvalho Chehab
76f216855b
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 >
2020-03-02 14:04:06 -07:00
Mauro Carvalho Chehab
de389cf08d
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 >
2020-03-02 14:03:55 -07:00
Mauro Carvalho Chehab
a1ef4bcd16
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 >
2020-03-02 14:03:48 -07:00
Mauro Carvalho Chehab
5040a0acc8
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 >
2020-03-02 14:03:48 -07:00
Mauro Carvalho Chehab
cdded7db36
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 >
2020-03-02 14:03:47 -07:00
Mauro Carvalho Chehab
5b7ac27a6e
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 >
2020-03-02 14:03:35 -07:00
Mauro Carvalho Chehab
720c2fc1ec
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 >
2020-03-02 14:03:18 -07:00
Mauro Carvalho Chehab
89272ca110
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 >
2020-03-02 14:03:16 -07:00
Mauro Carvalho Chehab
7dc6240632
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 >
2020-03-02 14:03:16 -07:00
Mauro Carvalho Chehab
6e29ad2ea3
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 >
2020-03-02 14:02:59 -07:00
Mauro Carvalho Chehab
e66d8631dd
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 >
2020-03-02 14:02:57 -07:00
Mauro Carvalho Chehab
06dedb45b7
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 >
2020-03-02 14:02:57 -07:00
Mauro Carvalho Chehab
b02a17cb8a
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 >
2020-03-02 14:02:40 -07:00
Mauro Carvalho Chehab
14a19fa5cf
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 >
2020-03-02 14:02:24 -07:00
Mauro Carvalho Chehab
5744378984
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 >
2020-03-02 14:02:23 -07:00
Mauro Carvalho Chehab
f1fa0e6028
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 >
2020-03-02 14:02:07 -07:00
Mauro Carvalho Chehab
471379a174
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 >
2020-03-02 14:01:53 -07:00
Mauro Carvalho Chehab
5d43e1bc2d
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 >
2020-03-02 14:01:28 -07:00
Mauro Carvalho Chehab
ee68f34d7e
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 >
2020-03-02 14:01:26 -07:00
Mauro Carvalho Chehab
c54ad9a4e8
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 >
2020-03-02 14:01:25 -07:00
Mauro Carvalho Chehab
c64d3dc69f
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 >
2020-03-02 14:01:25 -07:00
Mauro Carvalho Chehab
ca6e9049a0
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 >
2020-03-02 14:01:25 -07:00
Mauro Carvalho Chehab
7627216830
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 >
2020-03-02 14:01:06 -07:00
Mauro Carvalho Chehab
348739003d
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 >
2020-03-02 13:58:44 -07:00
Mauro Carvalho Chehab
07d241fd66
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 >
2020-03-02 13:58:44 -07:00
Niklas Söderlund
3eb30c51a6
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: f9a9349846 ("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 >
2020-03-02 13:11:46 -07:00
Tim Bird
c428cd5228
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 >
2020-03-02 13:08:11 -07:00
Zenghui Yu
ae5977765a
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 >
2020-03-02 13:04:57 -07:00
Sameer Rahmani
5fed00dcac
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 >
2020-03-02 13:03:44 -07:00
Sameer Rahmani
669a5cc8c5
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 >
2020-03-02 13:02:45 -07:00
Jakub Kicinski
373e8ffafd
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 >
2020-03-02 12:57:03 -07:00
Jakub Kicinski
f3431ba715
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 >
2020-03-02 12:57:03 -07:00
Jakub Kicinski
69654d37cf
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 >
2020-03-02 12:57:03 -07:00
Jakub Kicinski
2551cab599
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 >
2020-03-02 12:57:03 -07:00
Jakub Kicinski
d0c3bacb3e
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 >
2020-03-02 12:57:03 -07:00
Jonathan Neuschäfer
adf3f38a87
docs: kernel-docs: Remove "Here is its" at the end of lines
...
Before commit 9e03ea7f68 ("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 >
2020-03-02 12:52:24 -07:00
Jonathan Neuschäfer
7fe068dba8
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 >
2020-03-02 12:51:37 -07:00
Jonathan Neuschäfer
0a464ea4dc
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 >
2020-03-02 12:51:02 -07:00
Manivannan Sadhasivam
ef45e78fdc
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 >
2020-02-25 03:39:10 -07:00
Stephen Kitt
021622df55
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 >
2020-02-25 03:35:16 -07:00
Alex Hung
bf347b9da9
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 >
2020-02-25 03:34:25 -07:00
Stephen Kitt
2bd49cb581
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 >
2020-02-25 03:27:23 -07:00
Jonathan Corbet
2f5ab6225f
Merge tag 'docs-5.6-fixes' into docs-next
...
A pair of docs-build fixes.
2020-02-25 03:22:29 -07:00