- 05 May, 2020 36 commits
-
-
Vitor Massaru Iha authored
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.orgSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Federico Vaga authored
Translation for the following patches: commit c4f4af40 ("docs: Add documentation for Symbol Namespaces") commit 36bc683d ("kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'") commit a035d552 ("Makefile: Globally enable fall-through warning") commit b9918bdc ("Documentation/process: Add fallthrough pseudo-keyword") commit 58ad30cf ("docs: fix reference to core-api/namespaces.rst") commit fb0e0ffe ("Documentation: bring process docs up to date") commit 7af51678 ("docs: deprecated.rst: Add BUG()-family") commit 7929b983 ("docs: Remove :c:func: from process/deprecated.rst") commit 76136e02 ("docs: deprecated.rst: Clean up fall-through details") commit d8401f50 ("docs: deprecated.rst: Add %p to the list") commit b1735296 ("docs: locking: Drop :c:func: throughout") commit 6adb7755 ("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.itSigned-off-by:
-
Vitor Massaru Iha authored
This fixes: Documentation/misc-devices/uacce.rst: WARNING: document isn't included in any toctree Signed-off-by:
-
Joshua Abraham authored
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-ZenBookSigned-off-by:
-
Wolfram Sang authored
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.orgSigned-off-by:
-
Qi Zheng authored
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.comSigned-off-by:
-
Jonathan Corbet authored
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.
-
Mauro Carvalho Chehab authored
- 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.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
- 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 authored
- 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 authored
- 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 authored
- 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 authored
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 authored
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 authored
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 authored
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 authored
- 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 authored
- 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 authored
- Add a SPDX header; - Adjust document title; - Some whitespace fixes and new line breaks; - Add it to filesystems/index.rst. Signed-off-by:
Jan Kara <jack@suse.cz> Link: https://lore.kernel.org/r/10a707377475bb252f454af2b8f58a038527933f.1588021877.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
- 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 authored
- 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 authored
- Add a SPDX header; - Adjust document and section titles; - Add it to filesystems/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Add a document title; - Add it to filesystems/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- 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 authored
- 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 authored
- 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 authored
- 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 authored
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 authored
- 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 authored
- 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 authored
- 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 authored
- 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 authored
- 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 authored
- 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 authored
- 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 authored
- 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:
-
- 28 Apr, 2020 4 commits
-
-
Mauro Carvalho Chehab authored
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 authored
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 authored
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 authored
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:
-
