Vitor Massaru Iha
effa2cd84c
docs: coresight: fix make htmldocs warning
...
Fix `make htmldocs` warning:
Documentation/trace/coresight/coresight-ect.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
Signed-off-by: Vitor Massaru Iha <vitor@massaru.org >
Link: https://lore.kernel.org/r/20200430203612.90404-1-vitor@massaru.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:44:30 -06:00
Federico Vaga
b67aa4ef68
doc:it_IT: align Italian translation
...
Translation for the following patches:
commit c4f4af4094 ("docs: Add documentation for Symbol Namespaces")
commit 36bc683dde ("kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'")
commit a035d552a9 ("Makefile: Globally enable fall-through warning")
commit b9918bdcac ("Documentation/process: Add fallthrough pseudo-keyword")
commit 58ad30cf91 ("docs: fix reference to core-api/namespaces.rst")
commit fb0e0ffe7f ("Documentation: bring process docs up to date")
commit 7af51678b6 ("docs: deprecated.rst: Add BUG()-family")
commit 7929b9836e ("docs: Remove :c:func: from process/deprecated.rst")
commit 76136e028d ("docs: deprecated.rst: Clean up fall-through details")
commit d8401f504b ("docs: deprecated.rst: Add %p to the list")
commit b1735296ce ("docs: locking: Drop :c:func: throughout")
commit 6adb775599 ("docs: locking: Add 'need' to hardirq section")
Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it >
Link: https://lore.kernel.org/r/20200430222037.4480-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:42:26 -06:00
Vitor Massaru Iha
16a398d176
doc: misc-device: add uacce to toctree(index)
...
This fixes:
Documentation/misc-devices/uacce.rst: WARNING: document isn't included in any toctree
Signed-off-by: Vitor Massaru Iha <vitor@massaru.org >
Link: https://lore.kernel.org/r/20200430225828.114033-1-vitor@massaru.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:41:59 -06:00
Joshua Abraham
35c5999005
docs: kvm: Fix KVM_KVMCLOCK_CTRL API doc
...
The KVM_KVMCLOCK_CTRL ioctl signals to supported KVM guests
that the hypervisor has paused it. Update the documentation to
reflect that the guest is notified by this API.
Signed-off-by: Joshua Abraham <sinisterpatrician@gmail.com >
Link: https://lore.kernel.org/r/20200501223624.GA25826@josh-ZenBook
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:40:54 -06:00
Wolfram Sang
094d6dc562
watchdog: update email address in conversion doc
...
The old one is defunct. However, I think it makes sense that I am still
the primary contact person for updates here.
Signed-off-by: Wolfram Sang <wsa@kernel.org >
Link: https://lore.kernel.org/r/20200502143103.19473-1-wsa@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:39:53 -06:00
Qi Zheng
3eaa3bfa38
kobject: documentation: Fix erroneous function example in kobject doc.
...
Update the definitions of some functions listed in the kobject
document, since they have been changed.
Signed-off-by: Qi Zheng <arch0.zheng@gmail.com >
Link: https://lore.kernel.org/r/20200505061828.42952-1-arch0.zheng@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:36:48 -06:00
Jonathan Corbet
919e2bb8b6
Merge branch 'mauro' into docs-next
...
Mauro says:
This is the second part of a series I wrote sometime ago where I manually
convert lots of files to be properly parsed by Sphinx as ReST files.
As it touches on lot of stuff, this series is based on today's linux-next,
at tag next-20190617.
The first version of this series had 57 patches. The first part with 28 patches
were already merged. Right now, there are still ~76 patches pending applying
(including this series), and that's because I opted to do ~1 patch per converted
directory.
That sounds too much to be send on a single round. So, I'm opting to split
it on 3 parts for the conversion, plus a final patch adding orphaned books
to existing ones.
Those patches should probably be good to be merged either by subsystem
maintainers or via the docs tree.
I opted to mark new files not included yet to the main index.rst (directly or
indirectly) with the :orphan: tag, in order to avoid adding warnings to the
build system. This should be removed after we find a "home" for all
the converted files within the new document tree arrangement, after I
submit the third part.
2020-05-05 09:28:56 -06:00
Mauro Carvalho Chehab
982649915d
docs: filesystems: convert configfs.txt to ReST
...
- Add a SPDX header;
- Adjust document and section titles;
- Use copyright symbol;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.
Also, as this file is alone on its own dir, and it doesn't
seem too likely that other documents will follow it, let's
move it to the filesystems/ root documentation dir.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/c2424ec2ad4d735751434ff7f52144c44aa02d5a.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:23:25 -06:00
Mauro Carvalho Chehab
fc2f6fe745
docs: filesystems: convert xfs-self-describing-metadata.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/7c26b200e12cfc07b9bd379612452d845a8d1474.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:24 -06:00
Mauro Carvalho Chehab
c3d2f6cb4c
docs: filesystems: convert xfs-delayed-logging-design.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/2233c248f12e7b465cd27ee30a86f96eb632946a.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:24 -06:00
Mauro Carvalho Chehab
ec4551f450
docs: filesystems: convert sysfs-tagging.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/45a01fa5edd5c6ee8fc0754fc74f7ef65a3e5581.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:24 -06:00
Mauro Carvalho Chehab
28bcadf0ae
docs: filesystems: convert sysfs-pci.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 >
Link: https://lore.kernel.org/r/2a9d307753c97d1a843341a2ef1993d43a407ded.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:24 -06:00
Mauro Carvalho Chehab
e2975d7ca8
docs: filesystems: convert spufs/spu_run.txt to ReST
...
This file is at groff output format. Manually convert it to
ReST format, trying to preserve a similar output after parsed.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/7d8ee1edf5ef0137009bc65ff0441826ce555895.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:24 -06:00
Mauro Carvalho Chehab
299cd2747c
docs: filesystems: convert spufs/spufs.txt to ReST
...
This file is at groff output format. Manually convert it to
ReST format, trying to preserve a similar output after parsed.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/9ca05fad12390931bc7da0fa2502d1a450a4b87f.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:24 -06:00
Mauro Carvalho Chehab
dc3f043ff0
docs: filesystems: convert spufs/spu_create.txt to ReST
...
This file is at groff output format. Manually convert it to
ReST format, trying to preserve a similar output after parsed.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/4d42e97d5560a79bd5dd443c592be04f9ae9a757.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:23 -06:00
Mauro Carvalho Chehab
a5a1c349ac
docs: filesystems: split spufs.txt into 3 separate files
...
This file has manpages for 3 different things. As we'll
be converting it to ReST, let's fist split it into their
individual components.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/3753aa73524f4e1cbf0c19e34f7b322420e0b1c6.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:23 -06:00
Mauro Carvalho Chehab
cf06612c65
docs: filesystems: convert sharedsubtree.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/6692b8abc177130e9e53aace94117a2ad076cab5.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:23 -06:00
Mauro Carvalho Chehab
53a41d3eec
docs: filesystems: convert seq_file.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 it to filesystems/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/f950a0a56178ee05872ae2a2711a04d7af8ebb24.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:23 -06:00
Mauro Carvalho Chehab
9b6f151e76
docs: filesystems: convert quota.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 >
Acked-by: Jan Kara <jack@suse.cz >
Link: https://lore.kernel.org/r/10a707377475bb252f454af2b8f58a038527933f.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:23 -06:00
Mauro Carvalho Chehab
791a17ee19
docs: filesystems: convert mount_api.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 lists markups;
- Add it to filesystems/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/32332c1659a28c22561cb5e64162c959856066b4.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:23 -06:00
Mauro Carvalho Chehab
a02dcdf65b
docs: filesystems: convert mandatory-locking.txt to ReST
...
- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- 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/aecd6259fe9f99b2c2b3440eab6a2b989125e00d.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:22 -06:00
Mauro Carvalho Chehab
63526525dd
docs: filesystems: convert locks.txt to ReST
...
- Add a SPDX header;
- Adjust document and section titles;
- Add it to filesystems/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/467b3f20e63d2640d22599b99229699b5fb79251.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:22 -06:00
Mauro Carvalho Chehab
ba302d2a8e
docs: filesystems: convert fuse-io.txt to ReST
...
- Add a SPDX header;
- Add a document title;
- Add it to filesystems/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/88ec8025c1c5fc3ac5b65f1151c41ebcc696dc0e.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:22 -06:00
Mauro Carvalho Chehab
e6d42cb19c
docs: filesystems: convert files.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/e31b0f6a7ee466a233dc7f9c73f53f07ebb07f0b.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:22 -06:00
Mauro Carvalho Chehab
e6f7df74ec
docs: filesystems: convert fiemap.txt to ReST
...
- Add a SPDX header;
- 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/9182d49ffca7a0580e32ab24ecf5f8cc8d8924af.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:22 -06:00
Mauro Carvalho Chehab
b31763cff4
docs: filesystems: convert dnotify.txt to ReST
...
- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Add table 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/b39d6430d1c28438e833f01cb4597eff78703c75.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:22 -06:00
Mauro Carvalho Chehab
01478b8331
docs: filesystems: convert devpts.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/4ac8f3a7edd4d817acf0d173ead7ef74fe010c6c.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:21 -06:00
Mauro Carvalho Chehab
f476c6ed17
docs: filesystems: convert coda.txt to ReST
...
This document has its own style. It seems to be print output
for the old matrixial printers where backspace were used to
do double prints.
For the conversion, I used several regex expressions to get
rid of some weird stuff. The patch also does almost all possible
conversions in order to get a nice output document, while keeping
it readable/editable as is:
- Add a SPDX header;
- Add a document title;
- Adjust document title;
- Adjust section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Adjust list markups;
- Mark some unumbered titles with bold font;
- Use footnoote markups;
- 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/25c06c40c3d7b947a131c3be124ce0e93cc00ae3.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:21 -06:00
Mauro Carvalho Chehab
41defb4d0d
docs: filesystems: convert automount-support.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/ba7e2f2bf9aa2c7096772f5e7e8e609cb5fce07c.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:21 -06:00
Mauro Carvalho Chehab
175cc46f4d
docs: filesystems: convert cifs/cifsroot.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/28de01ee52283287e4195cf736d7154f122d30d4.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:21 -06:00
Mauro Carvalho Chehab
0e822145b5
docs: filesystems: caching/backend-api.txt: convert it 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/caching/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/5d0a61abaa87bfe913b9e2f321e74ef7af0f3dfc.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:21 -06:00
Mauro Carvalho Chehab
d74802ade7
docs: filesystems: caching/cachefiles.txt: convert to ReST
...
- Add a SPDX header;
- Adjust document title;
- Mark literal blocks as such;
- Add table markups;
- Comment out text ToC for html/pdf output;
- Add lists markups;
- Add it to filesystems/caching/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/eec0cfc268e8dca348f760224685100c9c2caba6.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:21 -06:00
Mauro Carvalho Chehab
09eac7c535
docs: filesystems: caching/operations.txt: convert it to ReST
...
- Add a SPDX header;
- Adjust document and section titles;
- Comment out text ToC for html/pdf output;
- Mark literal blocks as such;
- Add it to filesystems/caching/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/97e71cc598a4f61df484ebda3ec06b63530ceb62.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:20 -06:00
Mauro Carvalho Chehab
efc930fa1d
docs: filesystems: caching/netfs-api.txt: convert it 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/caching/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/cfe4cb1bf8e1f0093d44c30801ec42e74721e543.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:20 -06:00
Mauro Carvalho Chehab
fd299b2a73
docs: filesystems: convert caching/fscache.txt to ReST format
...
- Add a SPDX header;
- Adjust document and section titles;
- Comment out text ToC for html/pdf output;
- Some whitespace fixes and new line breaks;
- 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/e33ec382a53cf10ffcbd802f6de3f384159cddba.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:20 -06:00
Mauro Carvalho Chehab
67145c23e7
docs: filesystems: convert caching/object.txt to ReST
...
- Add a SPDX header;
- Adjust document and section titles;
- Comment out text ToC for html/pdf output;
- Some whitespace fixes and new line breaks;
- Adjust the events list to make them look better for html output;
- Add it to filesystems/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/49026a8ea7e714c2e0f003aa26b975b1025476b7.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-05-05 09:22:20 -06:00
Mauro Carvalho Chehab
ec43a27fff
scripts: sphinx-pre-install: change the output order
...
When the script detects the need for an upgrade, it will
print either a warning or a note.
Let's change a little bit the order where messages will be
displayed, in order to make easier for the user to identify
the more important messages.
It should now be like this:
Detected OS: Fedora release 31 (Thirty One).
Sphinx version: 1.7.9
Note: It is recommended at least Sphinx version 2.4.4 if you need PDF support.
To upgrade Sphinx, use:
/usr/bin/python3 -m venv sphinx_2.4.4
. sphinx_2.4.4/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt
If you want to exit the virtualenv, you can use:
deactivate
All optional dependencies are met.
Needed package dependencies are met.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/20200421182758.04e0a53e@coco.lan
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:52:52 -06:00
Mauro Carvalho Chehab
412b09ddad
scripts: sphinx-pre-install: fix a bug when using with venv
...
When python3 creates a venv, it adds python into it!
This causes any upgrade recommendation to look like this:
/devel/v4l/docs/sphinx_1.7.9/bin/python3 -m venv sphinx_2.4.4
. sphinx_2.4.4/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt
With is wrong (and it may not work). So, when recomending
an upgrade, exclude the venv dir from the search path, and
get the system's python.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/aa622ff71bebf6960fc0262fb90e7ebc7a999a02.1587478901.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:52:02 -06:00
Mauro Carvalho Chehab
2834a7412b
scripts: sphinx-pre-install: change recommendation text if venv exists
...
If one is running a Sphinx version older than what's recommended,
but there's already a newer working virtual env, change the
text, as it is just a matter of switching to the new venv, instead
of creating a new one from scratch.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/bcf79d0399a1c3444ca938dcdce599c3273980ab.1587478901.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:52:02 -06:00
Mauro Carvalho Chehab
1ef70ced55
scripts: sphinx-pre-install: change the warning for version < 2.4.4
...
As requested by Jon, change the version check, in order to not
emit a warning if version is >= 1.7.9, but below 2.4.4.
After this patch, if someone used an older version, it will
say:
./scripts/sphinx-pre-install
Sphinx version 1.7.9
Note: It is recommended at least Sphinx version 2.4.4 if you need PDF support.
Detected OS: Fedora release 31 (Thirty One).
To upgrade Sphinx, use:
/devel/v4l/docs/sphinx_1.7.9/bin/python3 -m venv sphinx_2.4.4
. sphinx_2.4.4/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt
If you want to exit the virtualenv, you can use:
deactivate
All optional dependencies are met.
Needed package dependencies are met.
If Sphinx is not detected at all, it
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/79584d317ba16f5d4f37801c5ee57cf04085f962.1587478901.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:52:02 -06:00
Mauro Carvalho Chehab
a8b380c379
scripts: sphinx-pre-install: only ask to activate valid venvs
...
If a venv doesn't contain Sphinx, or has an older Sphinx
version, ignore it.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/d11a00d88514e8a0357e1b0a05ebd518952a1d39.1587478901.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:52:02 -06:00
Michal Suchanek
1f5ea8720e
doc: nvdimm: remove reference to non-existent CONFIG_NFIT_TEST
...
The test driver is in tools/testing/nvdimm and cannot be selected by a
config option.
Signed-off-by: Michal Suchanek <msuchanek@suse.de >
Link: https://lore.kernel.org/r/20200415211654.10827-1-msuchanek@suse.de
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:46:07 -06:00
Stephen Kitt
6bc47621cb
docs: sysctl/kernel: document cad_pid
...
Based on the implementation in kernel/sysctl.c (the proc_do_cad_pid()
function), kernel/reboot.c, and include/linux/sched/signal.h.
Signed-off-by: Stephen Kitt <steve@sk2.org >
Link: https://lore.kernel.org/r/20200423183651.15365-1-steve@sk2.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:39:33 -06:00
Stephen Kitt
2ad9a844fc
docs: virt/kvm: close inline string literal
...
This fixes
Documentation/virt/kvm/amd-memory-encryption.rst:76: WARNING: Inline literal start-string without end-string.
Fixes: 2da1ed62d5 ("KVM: SVM: document KVM_MEM_ENCRYPT_OP, let userspace detect if SEV is available")
Signed-off-by: Stephen Kitt <steve@sk2.org >
Link: https://lore.kernel.org/r/20200424152637.120876-1-steve@sk2.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:37:00 -06:00
Stephen Kitt
920af1ce1b
docs: orangefs: fix pvfs2tab literal block
...
Following a merge fix-up, the literal block is introduced too early;
this patch merges the localhost mention with the introduction, fixing
Documentation/filesystems/orangefs.rst:124: WARNING: Literal block expected; none found.
Signed-off-by: Stephen Kitt <steve@sk2.org >
Link: https://lore.kernel.org/r/20200424153515.134500-1-steve@sk2.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:35:47 -06:00
Wolfram Sang
6feb76dbd1
Documentation: zh_CN: convert to use i2c_new_client_device()
...
Move away from the deprecated API and advertise the new one.
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com >
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com >
Link: https://lore.kernel.org/r/20200425100616.3363-1-wsa+renesas@sang-engineering.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:34:17 -06:00
Juan Manuel Méndez Rey
b529c06f9d
Update the documentation referencing Plan 9 from User Space.
...
The page originally referenced to checkout Plan9 application and libraries
have been missing for quite some time and the development is carried out
in github and documented on this new site.
Signed-off-by: Juan Manuel Méndez Rey <vejeta@gmail.com >
Link: https://lore.kernel.org/r/20200426015250.GA35090@camelot
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:32:31 -06:00
Leonardo Bras
08ce0c1e11
mailmap: Add entry for Leonardo Bras
...
Add an entry to connect my email addresses.
Signed-off-by: Leonardo Bras <leobras.c@gmail.com >
Link: https://lore.kernel.org/r/20200428024439.215806-1-leobras.c@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:27:45 -06:00
Flavio Suligoi
2d5694796b
Documentation: x86: fix space instead of tab in uefi doc
...
Signed-off-by: Flavio Suligoi <f.suligoi@asem.it >
Link: https://lore.kernel.org/r/1588080745-21999-1-git-send-email-f.suligoi@asem.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-28 12:27:17 -06:00
Adrian Freund
7b9121040d
Documentation: scheduler: fix outdated information on sched groups
...
The documentation claims that two sched groups must not overlap. This is
no longer true, as overlapping sched groups are used on NUMA systems.
This change has been introduced by commit e3589f6c81 and was
documented by an in-code comment in commit 35a566e6e8 .
Signed-off-by: Adrian Freund <adrian@freund.io >
Link: https://lore.kernel.org/r/20200407130525.76663-1-adrian@freund.io
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-04-21 13:38:27 -06:00