- 09 Nov, 2022 12 commits
-
-
Jonathan Corbet authored
Bring all of the 6.1 documentation fixes in.
-
Jonathan Neuschäfer authored
The correct term here, also used in the next line, is "identity mappings". "itentify mappings" was probably just a typo. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20221101160609.961950-1-j.neuschaefer@gmx.netSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Neuschäfer authored
The hw_random subsystem no longer works only on specific Intel chipsets; make the title of hw_random.rst reflect this fact. While we're at it, also remove the words "Linux support for", since it's clear from context that this is a document about Linux. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20221101160119.955997-1-j.neuschaefer@gmx.netSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yang Yingliang authored
Add some missing device-managed helpers of iio to devres.rst. devm_iio_kfifo_buffer_setup_ext() is introduced by commit 0a21526b ("iio: kfifo: add devm_iio_triggered_buffer_setup_ext variant"). devm_iio_triggered_buffer_setup_ext() is introduced by commit 5164c788 ("iio: triggered-buffer: add {devm_}iio_triggered_buffer_setup_ext variants"). devm_iio_hw_consumer_alloc() is introduced by b688c18d ("IIO: hw_consumer: add devm_iio_hw_consumer_alloc"). devm_fwnode_iio_channel_get_by_name() is introduced by commit 1e64b9c5 ("iio: inkern: move to fwnode properties"). Fixes: 0a21526b ("iio: kfifo: add devm_iio_triggered_buffer_setup_ext variant") Fixes: 5164c788 ("iio: triggered-buffer: add {devm_}iio_triggered_buffer_setup_ext variants") Fixes: b688c18d ("IIO: hw_consumer: add devm_iio_hw_consumer_alloc") Fixes: 1e64b9c5 ("iio: inkern: move to fwnode properties") Signed-off-by: Yang Yingliang <yangyingliang@huawei.com> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Link: https://lore.kernel.org/r/20221103023402.1024437-1-yangyingliang@huawei.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Randy Dunlap authored
Fix punctuation in a parenthetical phrase. Add 2 article adjectives and change one from "an" to "a". Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: "Rafael J. Wysocki" <rafael@kernel.org> Link: https://lore.kernel.org/r/20221104003835.29472-1-rdunlap@infradead.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Randy Dunlap authored
Make editing corrections and updates to sysfs.rst: - spell "sysfs" consistently (vs. "Sysfs") - align field names in a struct - fix some punctuation and grammar - list more /sys top-level subdirectories - change 'fuse.txt' to 'fuse.rst' (although I don't see where the example is) Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: "Rafael J. Wysocki" <rafael@kernel.org> Link: https://lore.kernel.org/r/20221104003921.31616-1-rdunlap@infradead.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
David Heidelberg authored
Nine years have passed since Linux 3.11. Signed-off-by: David Heidelberg <david@ixit.cz> Link: https://lore.kernel.org/r/20221104122612.14906-1-david@ixit.czSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Rui Li authored
Translate the following documents into Chinese: - userspace-api/futex2.rst Signed-off-by: Rui Li <me@lirui.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/20221105041741.288094-1-me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Alexander Potapenko authored
Add a blank line to make the sentence before the list render as a separate paragraph, not a definition. Fixes: 93858ae7 ("kmsan: add ReST documentation") Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Alexander Potapenko <glider@google.com> Link: https://lore.kernel.org/r/20221107142255.4038811-1-glider@google.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Akira Yokosawa authored
Reflect changes made in commits listed below: 388f9b20 ("Documentation/process/howto: Only send regression fixes after -rc1"). bc0ef4a7 ("Doc: Delete reference to the kernel-mentors mailing list") bcd3cf08 ("Doc: Remove outdated info about bugzilla mailing lists") dad05139 ("Doc: add a missing cross-reference") 9799445a ("Doc: tidy up TOCs and refs to license-rules.rst") fb0e0ffe ("Documentation: bring process docs up to date") e7b4311e ("Replace HTTP links with HTTPS ones: Documentation/process") f1eebe92 ("Documentation/HOWTO: adjust external link references") da514157 ("docs: make reporting-bugs.rst obsolete") cf6d6fc2 ("docs: process/howto.rst: make sections on bug reporting match practice") Co-developed-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Signed-off-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Acked-by: Tsugikazu Shibata <shibata@linuxfoundation.org> Link: https://lore.kernel.org/r/20221030115209.25924-1-akiyks@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Daniel Vetter authored
We love to nest our documenation for good structure, but that means the table of contents needs to keep up or you can't navigate them. Realized this trying to find the drm property documentation, which with some shuffling around disappeared. Why I didn't realize we can do this earlier, no idea. Since the relevant parts of the toc are only loaded if you're in the right .html file there's no harm in going all the way to unlimited. Note that this has no impact on the alabaster theme (which has a much simpler sidebar toc which doesn't show the entire hierarchy, only what's in the local rendered file) nor on the various :toctree: rendered inline in the output. Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20221108115707.1232621-1-daniel.vetter@ffwll.chSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Rui Li authored
Translate the following documents into Chinese: - userspace-api/seccomp_filter.rst Also adjust index order according to the original index file. Signed-off-by: Rui Li <me@lirui.org> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20221108112921.312071-1-me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 01 Nov, 2022 9 commits
-
-
Pali Rohár authored
Orion codenames are extracted from menuconfig ARCH_ORION5X and old Orion homepage with 88F5182/88F5281 was found in web archive. Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Andrew Lunn <andrew@lunn.ch> Link: https://lore.kernel.org/r/20220719080807.16729-1-pali@kernel.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Carlos Bilbao authored
Add Spanish translation of HOWTO document into rst based documentation build system. Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221024145521.69465-3-carlos.bilbao@amd.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Carlos Bilbao authored
Start the process of translating kernel documentation to Spanish. Create directory sp_SP/ instead of es_ES/ (diverging from format of prior translated directories) since this directory should accept any dialects of Spanish. Include an index and a disclaimer, following the approach of prior translations. Add Carlos Bilbao as MAINTAINER of this effort. Reviewed-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221024145521.69465-2-carlos.bilbao@amd.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Corbet authored
The alabaster theme likes to provide explicit sizes for fonts, which overrides the users's own browser settings and is guaranteed to displease folks. Set the font size to "inherit" so that the users browser settings control the font size they get. We can use the font_size configuration option for the main body font (changing the size I'd already put there), but the sidebar size can only be set via custom CSS. Reported-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
Translate .../rust/arch-support.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Gary Guo <gary@garyguo.net> Reviewed-by: Alex Shi <alexs@kernel.org> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/1f5b1d1e4f84bf105ab5bed146652937a74e9b69.1666959529.git.siyanteng@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
Translate .../rust/coding-guidelines.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Gary Guo <gary@garyguo.net> Reviewed-by: Alex Shi <alexs@kernel.org> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/ec8cb81c59a399dd9eced437cb196f4481c562e7.1666959529.git.siyanteng@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
Translate .../rust/general-information.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Gary Guo <gary@garyguo.net> Reviewed-by: Alex Shi <alexs@kernel.org> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/b623a39e3598e9dcd8ead4efa512694716403c48.1666959529.git.siyanteng@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
Translate .../rust/quick-start.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/00e9069e9259f4ba05f7c4c4ab64edcbe73d1eaf.1666959529.git.siyanteng@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
Translate .../rust/index.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Gary Guo <gary@garyguo.net> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/74e20d998bc2825d770c8b4d954e42b0d613ec09.1666959529.git.siyanteng@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 31 Oct, 2022 1 commit
-
-
Jonathan Corbet authored
This reverts commit d24c911b. This translation added a bunch of duplicate function definitions, leading to a lot of warnings like: /Documentation/core-api/timekeeping.rst:16: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:26. Declaration is '.. c:function:: ktime_t ktime_get( void )'. We need to come up with a proper way to translate documents with :c:function declarations in them. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 28 Oct, 2022 9 commits
-
-
Rui Li authored
Translate the following documents into Chinese: - userspace-api/sysfs-platform_profile.rst Signed-off-by: Rui Li <me@lirui.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20221026070732.72818-1-me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Rui Li authored
Translate the following documents into Chinese: - userspace-api/no_new_privs.rst Signed-off-by: Rui Li <me@lirui.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20221022120557.381115-1-me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Rui Li authored
Translate the following files into Chinese: - Documentation/staging/xz.rst Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Signed-off-by: Rui Li <me@lirui.org> Link: https://lore.kernel.org/r/281c6e063212aa337cccf549b816eec62e87c090.1666328379.git.me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Rui Li authored
Translate the following files into Chinese: - Documentation/staging/index.rst Add it into the menu of zh_CN/index. Also fix one translation in the zh_CN/index file. Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Signed-off-by: Rui Li <me@lirui.org> Link: https://lore.kernel.org/r/896caff38814b7c383324966c3936e8a0bfb1d2e.1666328379.git.me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Binbin Zhou authored
Translate core-api/errseq.rst into Chinese. Last English version used: commit 14ebc28e ("errseq: Add to documentation tree"). Signed-off-by: Binbin Zhou <zhoubinbin@loongson.cn> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/bd81bd620eb6c64effd2d0d52831f39911fc1659.1666171735.git.zhoubinbin@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Binbin Zhou authored
Translate core-api/timekeeping.rst into Chinese. Last English version used: commit 3dc6ffae ("timekeeping: Introduce fast accessor to clock tai"). Signed-off-by: Binbin Zhou <zhoubinbin@loongson.cn> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/8d15ff60aaadd53065b3bc2da7d53a520cf01c53.1666171735.git.zhoubinbin@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Binbin Zhou authored
Translate core-api/this_cpu_ops.rst into Chinese. Last English version used: commit c9b54d6f ("docs: move other kAPI documents to core-api"). Signed-off-by: Binbin Zhou <zhoubinbin@loongson.cn> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/f9a8cb188bc35811d7f074f9d5f607f5a48c6503.1666171735.git.zhoubinbin@loongson.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Rui Li authored
Translate the following documents into Chinese: - userspace-api/ebpf/index.rst - userspace-api/ebpf/syscall.rst Signed-off-by: Rui Li <me@lirui.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/cdd100d92752f76827fa7abfcd9903b857d71044.1666185911.git.me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Rui Li authored
Translate userspace-api/index.rst into Chinese, add it into zh_CN/index.rst. Signed-off-by: Rui Li <me@lirui.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/76b86e687034d5347e1e49c4acfc28e9c45abe47.1666185911.git.me@lirui.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 24 Oct, 2022 3 commits
-
-
Akira Yokosawa authored
Commit e8c07082 ("Kbuild: move to -std=gnu11") updated process/programming-language.rst, but failed to update process/howto.rst. Update howto.rst and resolve the inconsistency. Fixes: e8c07082 ("Kbuild: move to -std=gnu11") Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Arnd Bergmann <arnd@arndb.de> Cc: Federico Vaga <federico.vaga@vaga.pv.it> Cc: Alex Shi <alexs@kernel.org> Cc: Hu Haowen <src.res@email.cn> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Link: https://lore.kernel.org/r/20221015092201.32099-1-akiyks@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Mushahid Hussain authored
Fix `botton half locks` to `bottom half locks`. Signed-off-by: Mushahid Hussain <mushi.shar@gmail.com> Link: https://lore.kernel.org/r/20221017112026.88324-1-mushi.shar@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Nick Desaulniers authored
The existing table was a bit outdated. 3.16 was EOL in 2020. 4.4 was EOL in 2022. 5.10 is new in 2020. 5.15 is new in 2021. We'll see if 6.1 becomes LTS in 2022. Rather than keep this table updated, it does duplicate information from multiple kernel.org pages. Make one less duplication site that needs to be updated and simply refer to the kernel.org page on releases. Suggested-by: Tyler Hicks <code@tyhicks.com> Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Nick Desaulniers <ndesaulniers@google.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Link: https://lore.kernel.org/stable/20221014171040.849726-1-ndesaulniers%40google.comReviewed-by: Tyler Hicks (Microsoft) <code@tyhicks.com> Link: https://lore.kernel.org/r/20221014171040.849726-1-ndesaulniers@google.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 19 Oct, 2022 5 commits
-
-
Stephen Kitt authored
This brings the text markup in line with sysctl/abi and sysctl/kernel: * the entries are ordered alphabetically * the table of contents is automatically generated * markup is used as appropriate for constants etc. The content isn't fully up-to-date but the obsolete entries are gone, so remove the kernel version mention. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20220930102937.135841-6-steve@sk2.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Stephen Kitt authored
These were removed in 2.4.7.8. Remove references to super-max and super-nr in the sysctl documentation. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20220930102937.135841-5-steve@sk2.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Stephen Kitt authored
There are two sections documenting aio-nr and aio-max-nr, merge them. I kept the second explanation of aio-nr, which seems clearer to me, along with the effects of the values from the first section. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20220930102937.135841-4-steve@sk2.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Stephen Kitt authored
dquot-max was removed in 2.4.10.5; dquot-nr was replaced with dqstats in 2.5.18 which is now /proc/sys/fs/quota. Remove references to dquot-max and dquot-nr in the sysctl documentation. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20220930102937.135841-3-steve@sk2.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Stephen Kitt authored
inode-max was removed in 2.3.20pre1, remove references to it in the sysctl documentation. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20220930102937.135841-2-steve@sk2.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 18 Oct, 2022 1 commit
-
-
Jonathan Corbet authored
For a long time we have rejoiced that our HTML output from Sphinx is far better than what we got from the old DocBook toolchain. But it still leaves a lot to be desired; the following is an attempt to improve the situation somewhat. Sphinx has a theming mechanism for HTML rendering. Since the kernel's adoption of Sphinx, we have been using the "Read The Docs" theme — a choice made in a bit of a hurry to have *something* while figuring out the rest. RTD is OK, but it is not hugely attractive, requires the installation of an extra package, and does not observe all of the Sphinx configuration parameters. Among other things, that makes it hard to put reasonable contents into the left column in the HTML output. The Alabaster theme is the default for Sphinx installations, and is bundled with Sphinx itself. It has (IMO) nicer output and gives us the control that we need. So: switch to Alabaster. Additional patches adjust the documentation and remove the RTD references from scripts/sphinx-pre-install. The penultimate patch changes the way that kerneldoc declarations are rendered to (IMO) improve readability. That requires some changes to kernel-doc to output a new container block and some CSS tweaks to improve things overall. It should be noted that I have a long history of inflicting ugly web designs on the net; this work is a start, but I think we could do far better yet. It would be great if somebody who actually enjoys working with CSS and such would help to improve what we have.
-