summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs-6.2' of git://git.lwn.net/linuxLinus Torvalds2022-12-13106-993/+8539
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull documentation updates from Jonathan Corbet: "This was a not-too-busy cycle for documentation; highlights include: - The beginnings of a set of translations into Spanish, headed up by Carlos Bilbao - More Chinese translations - A change to the Sphinx "alabaster" theme by default for HTML generation. Unlike the previous default (Read the Docs), alabaster is shipped with Sphinx by default, reducing the number of other dependencies that need to be installed. It also (IMO) produces a cleaner and more readable result. - The ability to render the documentation into the texinfo format (something Sphinx could always do, we just never wired it up until now) Plus the usual collection of typo fixes, build-warning fixes, and minor updates" * tag 'docs-6.2' of git://git.lwn.net/linux: (67 commits) Documentation/features: Use loongarch instead of loong Documentation/features-refresh.sh: Only sed the beginning "arch" of ARCH_DIR docs/zh_CN: Fix '.. only::' directive's expression docs/sp_SP: Add memory-barriers.txt Spanish translation docs/zh_CN/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI docs/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI Documentation/features: Update feature lists for 6.1 Documentation: Fixed a typo in bootconfig.rst docs/sp_SP: Add process coding-style translation docs/sp_SP: Add kernel-docs.rst Spanish translation docs: Create translations/sp_SP/process/, move submitting-patches.rst docs: Add book to process/kernel-docs.rst docs: Retire old resources from kernel-docs.rst docs: Update maintainer of kernel-docs.rst Documentation: riscv: Document the sv57 VM layout Documentation: USB: correct possessive "its" usage math64: fix kernel-doc return value warnings math64: add kernel-doc for DIV64_U64_ROUND_UP math64: favor kernel-doc from header files doc: add texinfodocs and infodocs targets ...
| * Documentation/features: Use loongarch instead of loongTiezhu Yang2022-12-0542-42/+42
| | | | | | | | | | | | | | | | | | | | | | | | | | The official arch name is LoongArch [1], we should use small letter loongarch instead of loong in Documentation/features, just use the features-refresh.sh to refresh all the related files. [1] https://www.kernel.org/doc/html/latest/loongarch/index.html Fixes: 5860800e8696 ("Documentation/features: Update the arch support status files") Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn> Link: https://lore.kernel.org/r/1670156327-9631-3-git-send-email-yangtiezhu@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/features-refresh.sh: Only sed the beginning "arch" of ARCH_DIRTiezhu Yang2022-12-051-1/+1
| | | | | | | | | | | | | | | | | | | | It should only sed the beginning "arch" of ARCH_DIR in features-refresh.sh, otherwise loongarch is recognized as loong, that is not what we want. Fixes: be99f610a110 ("Documentation/features: Add script that refreshes the arch support status files in place") Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn> Link: https://lore.kernel.org/r/1670156327-9631-2-git-send-email-yangtiezhu@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: Fix '.. only::' directive's expressionAkira Yokosawa2022-12-051-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Commit febe6c2f859e ("docs/zh_CN: Add translation zh_CN/doc-guide/index.rst") translated ".. only::" directive too much. Use the one as found in the original doc-guide/index.rst. Fixes: febe6c2f859e ("docs/zh_CN: Add translation zh_CN/doc-guide/index.rst") Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Wu XiangCheng <bobwxc@email.cn> Cc: Yanteng Si <siyanteng@loongson.cn> Cc: Alex Shi <alexs@kernel.org> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/20221205032622.8697-1-akiyks@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/sp_SP: Add memory-barriers.txt Spanish translationCarlos Bilbao2022-12-033-0/+3154
| | | | | | | | | | | | | | | | | | | | | | | | Translate the following documents into Spanish: - memory-barriers.txt using the wrapper documents system. Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221128152323.4080455-1-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABITiezhu Yang2022-12-031-4/+4
| | | | | | | | | | | | | | | | | | | | The current links of LoongArch ISA Vol1 and ELF psABI are invalid, the latest versions are 1.02 and 2.00 respectively, let us update the links. Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn> Link: https://lore.kernel.org/r/1669892345-7763-3-git-send-email-yangtiezhu@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABITiezhu Yang2022-12-031-4/+4
| | | | | | | | | | | | | | | | | | | | The current links of LoongArch ISA Vol1 and ELF psABI are invalid, the latest versions are 1.02 and 2.00 respectively, let us update the links. Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn> Link: https://lore.kernel.org/r/1669892345-7763-2-git-send-email-yangtiezhu@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/features: Update feature lists for 6.1Wei Li2022-12-036-7/+7
| | | | | | | | | | | | | | | | | | Run the refresh script to document the recent feature additions on loong, um and csky as of v6.1-rc7. Signed-off-by: Wei Li <liwei391@huawei.com> Link: https://lore.kernel.org/r/20221203093750.4145802-1-liwei391@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: Fixed a typo in bootconfig.rstKushagra Verma2022-12-031-1/+1
| | | | | | | | | | | | | | | | Fixed a typo in the word 'concatenated'. Signed-off-by: Kushagra Verma <kushagra765@outlook.com> Link: https://lore.kernel.org/r/HK0PR01MB2801DA243B726141A97FE92EF8179@HK0PR01MB2801.apcprd01.prod.exchangelabs.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/sp_SP: Add process coding-style translationCarlos Bilbao2022-11-282-0/+1316
| | | | | | | | | | | | | | | | Translate Documentation/process/coding-style.rst into Spanish. Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221124170242.1892751-7-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/sp_SP: Add kernel-docs.rst Spanish translationCarlos Bilbao2022-11-282-0/+188
| | | | | | | | | | | | | | | | Translate Documentation/process/kernel-docs.rst into Spanish. Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221124170242.1892751-6-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Create translations/sp_SP/process/, move submitting-patches.rstCarlos Bilbao2022-11-283-3/+15
| | | | | | | | | | | | | | | | | | | | The organization of the Spanish translations should be consistent with the rest of kernel documentation. Create directory process/ and move submitting-patches.rst there. Update indexes accordingly. Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221124170242.1892751-5-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Add book to process/kernel-docs.rstCarlos Bilbao2022-11-281-0/+8
| | | | | | | | | | | | | | | | | | Include to process/kernel-docs.rst a book on Linux kernel development published in 2021 (with ISBN 978-1789953435). Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221124170242.1892751-4-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Retire old resources from kernel-docs.rstCarlos Bilbao2022-11-281-458/+7
| | | | | | | | | | | | | | | | | | | | | | Remove outdated or obsolete resources from process/kernel-docs.rst, with the exception of foundational material. Update information regarding LWN.net. See Link below for further context. Link: https://lore.kernel.org/lkml/093907af-2e4e-d232-1eb0-7331ff2b9320@amd.com/ Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221124170242.1892751-3-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Update maintainer of kernel-docs.rstCarlos Bilbao2022-11-282-5/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | Set new maintainer of the Index of Further Kernel Documentation (document process/kernel_docs.rst). See Link for further context. Also remove line that keeps record of last update of the text -this information is already available elsewhere. Link: https://lore.kernel.org/lkml/20221118170942.2588412-1-carlos.bilbao@amd.com/ Reviewed-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221124170242.1892751-2-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: riscv: Document the sv57 VM layoutBjörn Töpel2022-11-211-0/+36
| | | | | | | | | | | | | | | | | | | | | | RISC-V has been supporting the "sv57" address translation mode for a while, but is has not been added to the VM layout documentation. Let us fix that. Signed-off-by: Björn Töpel <bjorn@rivosinc.com> Reviewed-by: Alexandre Ghiti <alexghiti@rivosinc.com> Link: https://lore.kernel.org/r/20221118171556.1612190-1-bjorn@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: USB: correct possessive "its" usageRandy Dunlap2022-11-213-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | Correct uses of "it's" to possessive "its" or "its" to "it's" as needed. Correct associated grammar in one location. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: linux-usb@vger.kernel.org Link: https://lore.kernel.org/r/20221118231422.14076-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * math64: fix kernel-doc return value warningsLiam Beguin2022-11-211-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | Fix the following kernel-doc warnings by adding a description for return values of div_[us]64. math64.h:126: warning: No description found for return value of 'div_u64' math64.h:139: warning: No description found for return value of 'div_s64' Signed-off-by: Liam Beguin <liambeguin@gmail.com> Link: https://lore.kernel.org/r/20221118182309.3824530-3-liambeguin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * math64: add kernel-doc for DIV64_U64_ROUND_UPLiam Beguin2022-11-211-0/+10
| | | | | | | | | | | | | | | | | | | | | | Add kernel-doc for DIV64_U64_ROUND_UP so that it appears in the documentation. Signed-off-by: Liam Beguin <liambeguin@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20221118182309.3824530-2-liambeguin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * math64: favor kernel-doc from header filesLiam Beguin2022-11-213-22/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix the kernel-doc markings for div64 functions to point to the header file instead of the lib/ directory. This avoids having implementation specific comments in generic documentation. Furthermore, given that some kernel-doc comments are identical, drop them from lib/math64 and only keep there comments that add implementation details. Signed-off-by: Liam Beguin <liambeguin@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20221118182309.3824530-1-liambeguin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: add texinfodocs and infodocs targetsMaxim Cournoyer2022-11-213-2/+14
| | | | | | | | | | | | | | | | | | | | Sphinx supports generating Texinfo sources and Info documentation, which can be navigated easily and is convenient to search (via the indexed nodes or anchors, for example). Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Link: https://lore.kernel.org/r/20221116190210.28407-2-maxim.cournoyer@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: devres: add missing PWM helperYang Yingliang2022-11-211-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add missing devm_pwmchip_add() to devres.rst. It's introduced by commit bcda91bf86c1 ("pwm: Add a device-managed function to add PWM chips"). Fixes: bcda91bf86c1 ("pwm: Add a device-managed function to add PWM chips") Cc: Thierry Reding <thierry.reding@gmail.com> Cc: "Uwe Kleine-König" <u.kleine-koenig@pengutronix.de> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Yang Yingliang <yangyingliang@huawei.com> Acked-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Link: https://lore.kernel.org/r/20221102024430.1444714-1-yangyingliang@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: update the description of TracerPid in procfs.rstChen Linxuan2022-11-151-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>
| * Documentation: devres: add missing LED helpersYang Yingliang2022-11-151-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>
| * docs/sp_SP: Add process submitting-patches translationCarlos Bilbao2022-11-152-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>
| * docs/zh_CN: Add userspace-api/accelerators/ocxl Chinese translationRui Li2022-11-152-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>
| * Documentation: eisa: Fix typoAlbert Zhou2022-11-151-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>
| * Merge branch 'docs-fixes' into docs-mwJonathan Corbet2022-11-099-19/+12
| |\ | | | | | | | | | Bring all of the 6.1 documentation fixes in.
| * | docs: ia64: Fix a typo ("identify mappings")Jonathan Neuschäfer2022-11-091-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>
| * | docs: admin-guide: hw_random: Make document title more generic and conciseJonathan Neuschäfer2022-11-091-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>
| * | Documentation: devres: add missing IIO helpersYang Yingliang2022-11-091-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>
| * | debugfs: small Documentation cleaningRandy Dunlap2022-11-091-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>
| * | sysfs: update DocumentationRandy Dunlap2022-11-091-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>
| * | Docs/admin-guide/mm/zswap: remove a paragraph about zswap being a new featureDavid Heidelberg2022-11-091-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>
| * | docs/zh_CN: Add userspace-api/futex2 Chinese translationRui Li2022-11-092-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>
| * | docs: kmsan: fix formatting of "Example report"Alexander Potapenko2022-11-091-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>
| * | docs/ja_JP/howto: Update for v6.1Akira Yokosawa2022-11-091-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>
| * | docs/sphinx: More depth in the rtd sidebar tocDaniel Vetter2022-11-091-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>
| * | docs/zh_CN: Add userspace-api/seccomp_filter Chinese translationRui Li2022-11-092-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>
| * | Documentation: arm: marvell: Add Orion codenames and archive homepagePali Rohár2022-11-021-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>
| * | Documentation: Add HOWTO Spanish translation into rst based build systemCarlos Bilbao2022-11-012-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>
| * | Documentation: Start translations to SpanishCarlos Bilbao2022-11-014-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>
| * | docs: Don't wire font sizes for HTML outputJonathan Corbet2022-11-012-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>
| * | docs/zh_CN: Add rust arch-support Chinese translationYanteng Si2022-11-012-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>
| * | docs/zh_CN: Add rust coding-guidelines Chinese translationYanteng Si2022-11-012-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>
| * | docs/zh_CN: Add rust general-information Chinese translationYanteng Si2022-11-012-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>
| * | docs/zh_CN: Add rust quick-start Chinese translationYanteng Si2022-11-012-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>
| * | docs/zh_CN: Add rust index Chinese translationYanteng Si2022-11-012-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>
| * | Revert "docs/zh_CN: core-api: Add timekeeping Chinese translation"Jonathan Corbet2022-10-312-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>
| * | docs/zh_CN: Add userspace-api/sysfs-platform_profile Chinese translationRui Li2022-10-282-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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-21 13:36:14 +0100