summaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2022-11-16Documentation: update the description of TracerPid in procfs.rstChen Linxuan1-1/+2
When the tracer of process is outside of current pid namespace, field `TracerPid` in /proc/<pid>/status will be 0, too, just like this process not have been traced. This is because that function `task_pid_nr_ns` used to get the pid of tracer will return 0 in this situation. Co-authored-by: Yuan Haisheng <heysion@deepin.com> Signed-off-by: Chen Linxuan <chenlinxuan@uniontech.com> Link: https://lore.kernel.org/r/20221102081517.19770-1-chenlinxuan@uniontech.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-16Documentation: devres: add missing LED helpersYang Yingliang1-0/+3
Add some missing device-managed helpers of led to devres.rst. devm_led_classdev_register_ext() is introduced by commit b2b998c0f944 ("leds: class: Improve LED and LED flash class registration API"). devm_led_trigger_register() is introduced by commit 9534cc31dda2 ("leds: core: add managed version of led_trigger_register"). devm_of_led_get() is introduced by commit e389240ad992 ("leds: Add managed API to get a LED from a device driver"). Signed-off-by: Yang Yingliang <yangyingliang@huawei.com> Link: https://lore.kernel.org/r/20221103021331.1007699-1-yangyingliang@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-16docs/sp_SP: Add process submitting-patches translationCarlos Bilbao2-0/+895
Translate Documentation/process/submitting-patches.rst into Spanish. Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221107150815.296699-1-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-16docs/zh_CN: Add userspace-api/accelerators/ocxl Chinese translationRui Li2-1/+169
Translate the following documents into Chinese: - userspace-api/accelerators/ocxl.rst Signed-off-by: Rui Li <me@lirui.org> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/20221113071554.476980-1-me@lirui.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-16Documentation: eisa: Fix typoAlbert Zhou1-1/+1
Fix a typo in the description of the kernel parameter eisa_bus.disable_dev within eisa.rst. Signed-off-by: Albert Zhou <albert.zhou.50@gmail.com> Link: https://lore.kernel.org/r/20221105080653.4741-1-albert.zhou.50@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-10Merge branch 'docs-fixes' into docs-mwJonathan Corbet9-19/+12
Bring all of the 6.1 documentation fixes in.
2022-11-10docs: ia64: Fix a typo ("identify mappings")Jonathan Neuschäfer1-1/+1
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.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-10docs: admin-guide: hw_random: Make document title more generic and conciseJonathan Neuschäfer1-3/+3
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.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-10Documentation: devres: add missing IIO helpersYang Yingliang1-0/+4
Add some missing device-managed helpers of iio to devres.rst. devm_iio_kfifo_buffer_setup_ext() is introduced by commit 0a21526bc1d4 ("iio: kfifo: add devm_iio_triggered_buffer_setup_ext variant"). devm_iio_triggered_buffer_setup_ext() is introduced by commit 5164c7889857 ("iio: triggered-buffer: add {devm_}iio_triggered_buffer_setup_ext variants"). devm_iio_hw_consumer_alloc() is introduced by b688c18d3006 ("IIO: hw_consumer: add devm_iio_hw_consumer_alloc"). devm_fwnode_iio_channel_get_by_name() is introduced by commit 1e64b9c5f9a0 ("iio: inkern: move to fwnode properties"). Fixes: 0a21526bc1d4 ("iio: kfifo: add devm_iio_triggered_buffer_setup_ext variant") Fixes: 5164c7889857 ("iio: triggered-buffer: add {devm_}iio_triggered_buffer_setup_ext variants") Fixes: b688c18d3006 ("IIO: hw_consumer: add devm_iio_hw_consumer_alloc") Fixes: 1e64b9c5f9a0 ("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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09debugfs: small Documentation cleaningRandy Dunlap1-4/+4
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09sysfs: update DocumentationRandy Dunlap1-17/+24
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09Docs/admin-guide/mm/zswap: remove a paragraph about zswap being a new featureDavid Heidelberg1-7/+1
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.cz Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09docs/zh_CN: Add userspace-api/futex2 Chinese translationRui Li2-1/+81
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09docs: kmsan: fix formatting of "Example report"Alexander Potapenko1-0/+1
Add a blank line to make the sentence before the list render as a separate paragraph, not a definition. Fixes: 93858ae70cf4 ("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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09docs/ja_JP/howto: Update for v6.1Akira Yokosawa1-35/+31
Reflect changes made in commits listed below: 388f9b20f98d ("Documentation/process/howto: Only send regression fixes after -rc1"). bc0ef4a7e4c3 ("Doc: Delete reference to the kernel-mentors mailing list") bcd3cf0855c5 ("Doc: Remove outdated info about bugzilla mailing lists") dad051395413 ("Doc: add a missing cross-reference") 9799445af124 ("Doc: tidy up TOCs and refs to license-rules.rst") fb0e0ffe7fc8 ("Documentation: bring process docs up to date") e7b4311ebcac ("Replace HTTP links with HTTPS ones: Documentation/process") f1eebe92c265 ("Documentation/HOWTO: adjust external link references") da514157c4f0 ("docs: make reporting-bugs.rst obsolete") cf6d6fc27936 ("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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09docs/sphinx: More depth in the rtd sidebar tocDaniel Vetter1-0/+4
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.ch Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-09docs/zh_CN: Add userspace-api/seccomp_filter Chinese translationRui Li2-2/+295
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02Documentation: arm: marvell: Add Orion codenames and archive homepagePali Rohár1-5/+7
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02Documentation: Add HOWTO Spanish translation into rst based build systemCarlos Bilbao2-0/+625
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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02Documentation: Start translations to SpanishCarlos Bilbao4-0/+84
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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02docs: Don't wire font sizes for HTML outputJonathan Corbet2-1/+3
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>
2022-11-02docs/zh_CN: Add rust arch-support Chinese translationYanteng Si2-4/+24
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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02docs/zh_CN: Add rust coding-guidelines Chinese translationYanteng Si2-1/+193
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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02docs/zh_CN: Add rust general-information Chinese translationYanteng Si2-1/+76
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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02docs/zh_CN: Add rust quick-start Chinese translationYanteng Si2-1/+212
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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-11-02docs/zh_CN: Add rust index Chinese translationYanteng Si2-0/+32
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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-31Revert "docs/zh_CN: core-api: Add timekeeping Chinese translation"Jonathan Corbet2-177/+5
This reverts commit d24c911bd031a299de39863f67ae7290d450d56e. 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>
2022-10-28docs/zh_CN: Add userspace-api/sysfs-platform_profile Chinese translationRui Li2-1/+41
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: Add userspace-api/no_new_privs Chinese translationRui Li2-1/+58
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: Add staging/xz Chinese translationRui Li2-1/+105
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: Add staging/index Chinese translationRui Li2-4/+26
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: core-api: Add errseq Chinese translationBinbin Zhou2-5/+145
Translate core-api/errseq.rst into Chinese. Last English version used: commit 14ebc28e07e6 ("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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: core-api: Add timekeeping Chinese translationBinbin Zhou2-1/+178
Translate core-api/timekeeping.rst into Chinese. Last English version used: commit 3dc6ffae2da2 ("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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: core-api: Add this_cpu_ops Chinese translationBinbin Zhou2-1/+286
Translate core-api/this_cpu_ops.rst into Chinese. Last English version used: commit c9b54d6f362c ("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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: Add userspace-api/ebpf Chinese translationRui Li3-1/+56
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-28docs/zh_CN: Add userspace-api/index Chinese translationRui Li2-1/+47
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-24docs/process/howto: Replace C89 with C11Akira Yokosawa6-6/+6
Commit e8c07082a810 ("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: e8c07082a810 ("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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-24Documentation: Fix spelling mistake in hacking.rstMushahid Hussain1-1/+1
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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-24Documentation: process: replace outdated LTS table w/ linkNick Desaulniers1-11/+4
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.com Reviewed-by: Tyler Hicks (Microsoft) <code@tyhicks.com> Link: https://lore.kernel.org/r/20221014171040.849726-1-ndesaulniers@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-20docs: sysctl/fs: re-order, prettifyStephen Kitt2-98/+92
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-20docs: sysctl/fs: remove references to super-max/-nrStephen Kitt1-10/+0
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-20docs: sysctl/fs: merge the aio sectionsStephen Kitt1-13/+5
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-20docs: sysctl/fs: remove references to dquot-max/-nrStephen Kitt1-16/+0
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-20docs: sysctl/fs: remove references to inode-maxStephen Kitt1-12/+4
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-19Merge branch 'alabaster-rb' into docs-mwJonathan Corbet6-220/+93
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.
2022-10-19docs: decruft Documentation/conf.pyJonathan Corbet1-179/+2
Remove the ancient support for the Sphinx "classic" theme; everybody will have alabaster, so that fallback is no longer needed. While in the neighborhood: get rid of lots of useless comment lines. They describe the state of Sphinx options when we first created that file and are just clutter now. Suggested-by: Mauro Carvalho Chehab <mchehab@kernel.org> Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-19docs: improve the HTML formatting of kerneldoc commentsJonathan Corbet2-22/+48
Make a few changes to cause functions documented by kerneldoc to stand out better in the rendered documentation. Specifically, change kernel-doc to put the description section into a ".. container::" section, then add a bit of CSS to indent that section relative to the function prototype (or struct or enum definition). Tweak a few other CSS parameters while in the neighborhood to improve the formatting. Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-19tracing/histogram: Update document for KEYS_MAX sizeZheng Yejian1-1/+1
After commit 4f36c2d85ced ("tracing: Increase tracing map KEYS_MAX size"), 'keys' supports up to three fields. Signed-off-by: Zheng Yejian <zhengyejian1@huawei.com> Cc: stable@vger.kernel.org Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> Link: https://lore.kernel.org/r/20221017103806.2479139-1-zhengyejian1@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-17Linux 6.1-rc1v6.1-rc1Linus Torvalds1-2/+2
2022-10-17Merge tag 'random-6.1-rc1-for-linus' of ↵Linus Torvalds185-421/+378
git://git.kernel.org/pub/scm/linux/kernel/git/crng/random Pull more random number generator updates from Jason Donenfeld: "This time with some large scale treewide cleanups. The intent of this pull is to clean up the way callers fetch random integers. The current rules for doing this right are: - If you want a secure or an insecure random u64, use get_random_u64() - If you want a secure or an insecure random u32, use get_random_u32() The old function prandom_u32() has been deprecated for a while now and is just a wrapper around get_random_u32(). Same for get_random_int(). - If you want a secure or an insecure random u16, use get_random_u16() - If you want a secure or an insecure random u8, use get_random_u8() - If you want secure or insecure random bytes, use get_random_bytes(). The old function prandom_bytes() has been deprecated for a while now and has long been a wrapper around get_random_bytes() - If you want a non-uniform random u32, u16, or u8 bounded by a certain open interval maximum, use prandom_u32_max() I say "non-uniform", because it doesn't do any rejection sampling or divisions. Hence, it stays within the prandom_*() namespace, not the get_random_*() namespace. I'm currently investigating a "uniform" function for 6.2. We'll see what comes of that. By applying these rules uniformly, we get several benefits: - By using prandom_u32_max() with an upper-bound that the compiler can prove at compile-time is ≤65536 or ≤256, internally get_random_u16() or get_random_u8() is used, which wastes fewer batched random bytes, and hence has higher throughput. - By using prandom_u32_max() instead of %, when the upper-bound is not a constant, division is still avoided, because prandom_u32_max() uses a faster multiplication-based trick instead. - By using get_random_u16() or get_random_u8() in cases where the return value is intended to indeed be a u16 or a u8, we waste fewer batched random bytes, and hence have higher throughput. This series was originally done by hand while I was on an airplane without Internet. Later, Kees and I worked on retroactively figuring out what could be done with Coccinelle and what had to be done manually, and then we split things up based on that. So while this touches a lot of files, the actual amount of code that's hand fiddled is comfortably small" * tag 'random-6.1-rc1-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/crng/random: prandom: remove unused functions treewide: use get_random_bytes() when possible treewide: use get_random_u32() when possible treewide: use get_random_{u8,u16}() when possible, part 2 treewide: use get_random_{u8,u16}() when possible, part 1 treewide: use prandom_u32_max() when possible, part 2 treewide: use prandom_u32_max() when possible, part 1
generated by cgit v1.2.3 (git 2.39.0) at 2025-08-16 18:05:19 +0300