- 02 Mar, 2020 18 commits
-
-
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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/8cae057ae244d0f5b58d3c209bcdae5ed82bc52c.1581955849.git.mchehab+huawei@kernel.orgSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
- 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 authored
- 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:
David Sterba <dsterba@suse.com> Link: https://lore.kernel.org/r/b44c56befe0e28cbc0eb1b3e281ad7d99737ff16.1581955849.git.mchehab+huawei@kernel.orgSigned-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; - 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:
-
Niklas Söderlund authored
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: f9a93498 ("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.seSigned-off-by:
-
Tim Bird authored
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.comSigned-off-by:
-
Zenghui Yu authored
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.comSigned-off-by:
-
Sameer Rahmani authored
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.orgSigned-off-by:
-
Sameer Rahmani authored
Reviewed and converted the `kobject.txt` format to rst in place. Signed-off-by:
-
Jakub Kicinski authored
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.orgSigned-off-by:
-
Jakub Kicinski authored
We need literal sections otherwise the entire example is rendered as a single line. Signed-off-by:
-
Jakub Kicinski authored
We need a literal section, like few paragraphs below. Signed-off-by:
-
Jakub Kicinski authored
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 authored
Fix tabs vs spaces issue which cases the line to be considered a new list entry. Signed-off-by:
-
Jonathan Neuschäfer authored
Before commit 9e03ea7f ("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.netSigned-off-by:
-
Jonathan Neuschäfer authored
drivers/tty/serial/imx.c implements these earlycon options. Signed-off-by:
-
Jonathan Neuschäfer authored
Signed-off-by:
-
- 25 Feb, 2020 10 commits
-
-
Manivannan Sadhasivam authored
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:
-
Stephen Kitt authored
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:
-
Alex Hung authored
"untrusted" was mis-spelled as "unstrusted" Signed-off-by:
Alex Hung <alex.hung@canonical.com> Signed-off-by:
-
Stephen Kitt authored
Based on the implementation in arch/x86/kernel/acpi/sleep.c, in particular the acpi_sleep_setup() function. Signed-off-by:
-
Jonathan Corbet authored
A pair of docs-build fixes.
-
Kees Cook authored
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: 51e46c7a ("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:
-
Stephen Kitt authored
MPX was removed in commit 45fc24e8 ("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:
Dave Hansen <dave.hansen@intel.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
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: 06d3ff6e ("drm/i915: move intel_csr.[ch] under display/") Signed-off-by:
-
Mauro Carvalho Chehab authored
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:
-
Michael Ellerman authored
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:
-
- 19 Feb, 2020 12 commits
-
-
Jonathan Neuschäfer authored
The EDID files are not really documentation. Signed-off-by:
-
Jonathan Neuschäfer authored
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 authored
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 authored
Without the empty lines, Sphinx renders the list as part of the running text. Signed-off-by:
-
Randy Dunlap authored
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:
-
Tony Fischetti authored
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:
-
Bhaskar Chowdhury authored
This patch replace stale/dead urls with active urls for Mutt. Signed-off-by:
Bhaskar Chowdhury <unixbhaskar@gmail.com> Signed-off-by:
-
Stephen Kitt authored
These have no corresponding code in the kernel. Signed-off-by:
-
Stephen Kitt authored
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 authored
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 authored
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 authored
The l2cr sysctl entry was removed in commit c2f3dabe ("sysctl: kill binary sysctl KERN_PPC_L2CR"), this removes the corresponding documentation. Signed-off-by:
-
