summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs-5.8' of git://git.lwn.net/linuxLinus Torvalds2020-06-02267-4354/+6317
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull documentation updates from Jonathan Corbet: "A fair amount of stuff this time around, dominated by yet another massive set from Mauro toward the completion of the RST conversion. I *really* hope we are getting close to the end of this. Meanwhile, those patches reach pretty far afield to update document references around the tree; there should be no actual code changes there. There will be, alas, more of the usual trivial merge conflicts. Beyond that we have more translations, improvements to the sphinx scripting, a number of additions to the sysctl documentation, and lots of fixes" * tag 'docs-5.8' of git://git.lwn.net/linux: (130 commits) Documentation: fixes to the maintainer-entry-profile template zswap: docs/vm: Fix typo accept_threshold_percent in zswap.rst tracing: Fix events.rst section numbering docs: acpi: fix old http link and improve document format docs: filesystems: add info about efivars content Documentation: LSM: Correct the basic LSM description mailmap: change email for Ricardo Ribalda docs: sysctl/kernel: document unaligned controls Documentation: admin-guide: update bug-hunting.rst docs: sysctl/kernel: document ngroups_max nvdimm: fixes to maintainter-entry-profile Documentation/features: Correct RISC-V kprobes support entry Documentation/features: Refresh the arch support status files Revert "docs: sysctl/kernel: document ngroups_max" docs: move locking-specific documents to locking/ docs: move digsig docs to the security book docs: move the kref doc into the core-api book docs: add IRQ documentation at the core-api book docs: debugging-via-ohci1394.txt: add it to the core-api book docs: fix references for ipmi.rst file ...
| * Documentation: fixes to the maintainer-entry-profile templateRandy Dunlap2020-06-011-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Do some wordsmithing and copy editing on the maintainer-entry-profile profile (template, guide): - fix punctuation - fix some wording - use "-rc" consistently Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Dan Williams <dan.j.williams@intel.com> Cc: linux-nvdimm@lists.01.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/fbaa9b67-e7b8-d5e8-ecbb-6ae068234880@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * zswap: docs/vm: Fix typo accept_threshold_percent in zswap.rstSedat Dilek2020-06-011-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Recently, I switched over from swap-file to zramswap. When reading the Documentation/vm/zswap.rst file I fell over this typo. The parameter is called accept_threshold_percent not accept_threhsold_percent in /sys/module/zswap/parameters/ directory. Fixes: 45190f01dd402 ("mm/zswap.c: add allocation hysteresis if pool limit is hit") Cc: Vitaly Wool <vitaly.wool@konsulko.com> Signed-off-by: Sedat Dilek <sedat.dilek@gmail.com> Link: https://lore.kernel.org/r/20200601005911.31222-1-sedat.dilek@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * tracing: Fix events.rst section numberingTom Zanussi2020-05-261-14/+14
| | | | | | | | | | | | | | | | | | | | | | The in-kernel trace event API should have its own section, and the duplicate section numbers need fixing as well. Reported-by: Li Xinhai <lixinhai.lxh@gmail.com> Signed-off-by: Tom Zanussi <zanussi@kernel.org> Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org> Link: https://lore.kernel.org/r/90ea854dfb728390b50ddf8a8675238973ee014a.camel@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: acpi: fix old http link and improve document formatFlavio Suligoi2020-05-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The website: http://wiki.minnowboard.org doesn't exist anymore. The same pages are moved to: https://www.elinux.org/Minnowboard Other improvements concern the introduction of some rst semantic markup in the document. Signed-off-by: Flavio Suligoi <f.suligoi@asem.it> Link: https://lore.kernel.org/r/20200519084128.12756-2-f.suligoi@asem.it Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: filesystems: add info about efivars contentFlavio Suligoi2020-05-261-0/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | When an EFI variable is reading from: /sys/firmware/efi/efivars (for example using "hexdump"), the first 4 bytes of the output are not the real EFI variable data, but the variable attributes (in little-endian format). Signed-off-by: Flavio Suligoi <f.suligoi@asem.it> Link: https://lore.kernel.org/r/20200519084128.12756-1-f.suligoi@asem.it Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: LSM: Correct the basic LSM descriptionCasey Schaufler2020-05-261-136/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | This is a first pass at updating the basic documentation on Linux Security Modules (LSM), which is frighteningly out of date. Remove untrue statements about the LSM framework. Replace them with true statements where it is convenient to do so. This is the beginnig of a larger effort to bring the LSM documentation up to date. Signed-off-by: Casey Schaufler <casey@schaufler-ca.com> Link: https://lore.kernel.org/r/4c053d72-2d58-612f-6d6b-f04226d0181e@schaufler-ca.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * mailmap: change email for Ricardo RibaldaRicardo Ribalda Delgado2020-05-268-13/+17
| | | | | | | | | | | | | | | | | | Modify emails to ribalda@kernel.org and unify my surname in all the files. Signed-off-by: Ricardo Ribalda <ribalda@kernel.org> Link: https://lore.kernel.org/r/20200430135224.362700-1-ricardo@ribalda.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: sysctl/kernel: document unaligned controlsStephen Kitt2020-05-263-0/+52
| | | | | | | | | | | | | | | | | | | | | | | | | | This documents ignore-unaligned-usertrap, unaligned-dump-stack, and unaligned-trap, based on arch/arc/kernel/unaligned.c, arch/ia64/kernel/unaligned.c, and arch/parisc/kernel/unaligned.c. While we're at it, integrate unaligned-memory-access.txt into the docs tree. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20200515212443.5012-1-steve@sk2.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: admin-guide: update bug-hunting.rstRandy Dunlap2020-05-261-22/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update Documentation/admin-guide/bug-hunting.rst: - add a small section on "Modules linked in" and their possible flags; - delete all references to ksymoops since it is no longer applicable; - fix spello, grammar, and punctuation; - note that get_maintainers.pl only provides recent patchers if it is run inside a git tree; - add mention of scripts/decode_stacktrace.sh; Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: greg@wind.rmcc.com Link: https://lore.kernel.org/r/c629a9ef-3867-c3d1-f6c9-2c3b0e4ac68a@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: sysctl/kernel: document ngroups_maxStephen Kitt2020-05-261-0/+9
| | | | | | | | | | | | | | | | This is a read-only export of NGROUPS_MAX. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20200518145836.15816-1-steve@sk2.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * nvdimm: fixes to maintainter-entry-profileRandy Dunlap2020-05-251-7/+7
| | | | | | | | | | | | | | | | | | Fix punctuation and wording in a few places. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Dan Williams <dan.j.williams@intel.com> Link: https://lore.kernel.org/r/103a0e71-28b5-e4c2-fdf2-80d2dd005b44@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/features: Correct RISC-V kprobes support entryBjörn Töpel2020-05-251-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | The Documentation/features/debug/kprobes/arch-support.txt incorrectly states that RISC-V has kprobes support. This is not the case. Note that entries that have been incorrectly marked with 'ok' will not be changed back to 'TODO' by the features-refresh.sh script. Fixes: 7156fc292850 ("Documentation/features: Refresh the arch support status files in place") Signed-off-by: Björn Töpel <bjorn.topel@gmail.com> Link: https://lore.kernel.org/r/20200523210005.59140-1-bjorn.topel@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/features: Refresh the arch support status filesBjörn Töpel2020-05-2516-21/+21
| | | | | | | | | | | | | | | | | | | | | | | | I was manually editing the arch-support.txt for eBPF-JIT, when I realized the refresh script [1] has not been run for a while. Let's fix that, so that the entries are more up-to-date. [1] Documentation/features/scripts/features-refresh.sh Signed-off-by: Björn Töpel <bjorn.topel@gmail.com> Link: https://lore.kernel.org/r/20200523191135.21889-1-bjorn.topel@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Revert "docs: sysctl/kernel: document ngroups_max"Jonathan Corbet2020-05-182-11/+2
| | | | | | | | | | | | | | | | | | | | This reverts commit 2f4c33063ad713e3a5b63002cf8362846e78bd71. The changes here were fine, but there's a non-documentation change to sysctl.c that makes messes elsewhere; those changes should have been done independently. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: move locking-specific documents to locking/Mauro Carvalho Chehab2020-05-1510-4/+11
| | | | | | | | | | | | | | | | | | | | Several files under Documentation/*.txt describe some type of locking API. Move them to locking/ subdir and add to the locking/index.rst index file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/dd833a10bbd0b2c1461d78913f5ec28a7e27f00b.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: move digsig docs to the security bookMauro Carvalho Chehab2020-05-152-0/+1
| | | | | | | | | | | | Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/6af5365404c7bd9d008e7e3a77ba83587fd33012.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: move the kref doc into the core-api bookMauro Carvalho Chehab2020-05-153-1/+2
| | | | | | | | | | | | | | | | | | This document covers core kernel objects. So, add it into the core-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/f385af13b4a6d3ff8c89beedd4506900e79ca72e.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: add IRQ documentation at the core-api bookMauro Carvalho Chehab2020-05-1512-9/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | There are 4 IRQ documentation files under Documentation/*.txt. Move them into a new directory (core-api/irq) and add a new index file for it. While here, use a title markup for the Debugging section of the irq-domain.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/2da7485c3718e1442e6b4c2dd66857b776e8899b.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: debugging-via-ohci1394.txt: add it to the core-api bookMauro Carvalho Chehab2020-05-154-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | There is an special chapter inside the core-api book about some debug infrastructure like tracepoints and debug objects. It sounded to me that this is the best place to add a chapter explaining how to use a FireWire controller to do remote kernel debugging, as explained on this document. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/9b489d36d08ad89d3ad5aefef1f52a0715b29716.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: fix references for ipmi.rst fileMauro Carvalho Chehab2020-05-154-4/+4
| | | | | | | | | | | | | | | | As this file got moved, fix references for it. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/b6c1ded590f27198de15b16237509128e55fa810.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: move IPMI.txt to the driver API bookMauro Carvalho Chehab2020-05-152-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | The IPMI is under drivers/char. This doc describes the kAPI part of the IPMI (mainly). So, move it to the driver-api directory and add it to the corresponding index.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/ae4edbc6753dc522cb93de36800978e3b58e0cfb.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: move DMA kAPI to Documentation/core-apiMauro Carvalho Chehab2020-05-155-0/+4
| | | | | | | | | | | | | | | | | | Move those files to the core-api, where they belong, renaming them to ReST and adding to the core API index file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/a1517185418cb9d987f566ef85a5dd5c7c99f34e.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: Fix some errors in ras.rstWaiman Long2020-05-151-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | Make some miscellaneous fixes to the first paragraph of "ECC memory": - Change the incorrect "74 bits" to "72 bits". - Change "mentioned on" to "mentioned in". - Remove the extra "extra". - Rephrase some sentences as suggested by Matthew Wilcox. Signed-off-by: Waiman Long <longman@redhat.com> Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org> Link: https://lore.kernel.org/r/20200506162217.16633-1-longman@redhat.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: update numastat explanationVlastimil Babka2020-05-151-3/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | During recent patch discussion [1] it became apparent that the "other_node" definition in the numastat documentation has always been different from actual implementation. It was also noted that the stats can be innacurate on systems with memoryless nodes. This patch corrects the other_node definition (with minor tweaks to two more definitions), adds a note about memoryless nodes and also two introductory paragraphs to the numastat documentation. [1] https://lore.kernel.org/linux-mm/20200504070304.127361-1-sandipan@linux.ibm.com/T/#u Signed-off-by: Vlastimil Babka <vbabka@suse.cz> Acked-by: Sandipan Das <sandipan@linux.ibm.com> Acked-by: Michal Hocko <mhocko@suse.com> Link: https://lore.kernel.org/r/20200507120217.12313-1-vbabka@suse.cz Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: vm: page_frags.rst: Fix the reference of stale functionKevin Hao2020-05-151-1/+1
| | | | | | | | | | | | | | | | | | | | The __netdev_alloc_frag() has been dropped by commit 7ba7aeabbaba ("net: Don't disable interrupts in napi_alloc_frag()"). So replace it with netdev_alloc_frag(). Signed-off-by: Kevin Hao <haokexin@gmail.com> Link: https://lore.kernel.org/r/20200508140924.18220-1-haokexin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: debugfs: Update struct debugfs_reg32 definitionRikard Falkeborn2020-05-151-2/+3
| | | | | | | | | | | | | | | | | | Update the docs to match the implementation, both the definition of struct debugfs_regset32 and the definition of debugfs_print_regs32(). Signed-off-by: Rikard Falkeborn <rikard.falkeborn@gmail.com> Link: https://lore.kernel.org/r/20200508212949.2867-1-rikard.falkeborn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: zh_CN: add translatation for debugfs.txtChucheng Luo2020-05-152-0/+222
| | | | | | | | | | | | | | | | | | | | | | | | Translate Documentation/filesystems/debugfs.txt into Chinese. Signed-off-by: Chucheng Luo <luochucheng@vivo.com> Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com> Signed-off-by: Wang Wenhu <wenhu.wang@vivo.com> [rebase for upstream conflict and minor change of subject] Link: https://lore.kernel.org/linux-doc/20200408021528.14062-1-luochucheng@vivo.com/ Link: https://lore.kernel.org/r/20200509080535.7625-1-wenhu.wang@vivo.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: sysctl/kernel: document ngroups_maxStephen Kitt2020-05-152-2/+11
| | | | | | | | | | | | | | | | | | | | This is a read-only export of NGROUPS_MAX, so this patch also changes the declarations in kernel/sysctl.c to const. Signed-off-by: Stephen Kitt <steve@sk2.org> Reviewed-by: Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/20200515160222.7994-1-steve@sk2.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: thermal: add cpu-idle-cooling to index treeWang Wenhu2020-05-052-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | Add cpu-idle-cooling.rst to the index list for user reference through self-compiled htmldocs or online documentation tree of kernel. Like: https://www.kernel.org/doc/html/latest/driver-api/thermal/index.html Signed-off-by: Wang Wenhu <wenhu.wang@vivo.com> Cc: Daniel Lezcano <daniel.lezcano@linaro.org> Link: https://lore.kernel.org/r/20200429131109.80891-1-wenhu.wang@vivo.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc:locking: remove info about old behavior of locktortureFederico Vaga2020-05-051-1/+1
| | | | | | | | | | | | | | | | | | It is not useful to know what was the default at some point in the past: remove the information. Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Link: https://lore.kernel.org/r/20200426211429.29133-1-federico.vaga@vaga.pv.it Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: sysctl/kernel: document firmware_configStephen Kitt2020-05-051-0/+13
| | | | | | | | | | | | | | | | | | Based on the firmware fallback mechanisms documentation and the implementation in drivers/base/firmware_loader/fallback.c. Signed-off-by: Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20200429205757.8677-2-steve@sk2.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: sysctl/kernel: document ftrace entriesStephen Kitt2020-05-051-0/+48
| | | | | | | | | | | | | | | | | | | | Based on the ftrace documentation, the tp_printk boot parameter documentation, and the implementation in kernel/trace/trace.c. Signed-off-by: Stephen Kitt <steve@sk2.org> Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org> Link: https://lore.kernel.org/r/20200429205757.8677-1-steve@sk2.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * samples: fix binderfs sampleArnd Bergmann2020-05-052-2/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A routine check for misspelled Kconfig symbols showed on instance from last year, the correct symbol name is CONFIG_ANDROID_BINDERFS, not CONFIG_CONFIG_ANDROID_BINDERFS, so the extra prefix must be removed in the Kconfig file to allow enabling the sample. As the actual sample fails to build as a kernel module, change the Makefile enough to get to build as a hostprog instead. Fixes: 9762dc1432e1 ("samples: add binderfs sample program") Signed-off-by: Arnd Bergmann <arnd@arndb.de> Acked-by: Christian Brauner <christian.brauner@ubuntu.com> Link: https://lore.kernel.org/r/20200428212555.2806258-1-arnd@arndb.de Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: s390: Fix wrong label Guest2 instead of Guest3Vitor Massaru Iha2020-05-051-1/+1
| | | | | | | | | | | | | | | | | | | | This fixes: Documentation/s390/vfio-ap.rst:488: WARNING: duplicate label s390/vfio-ap:guest2, other instance in /home/iha/sdb/opensource/lkmp/linux_doc/Documentation/s390/vfio-ap.rst Signed-off-by: Vitor Massaru Iha <vitor@massaru.org> Link: https://lore.kernel.org/r/20200430221238.101838-1-vitor@massaru.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: coresight: fix `make htmldocs` warningVitor Massaru Iha2020-05-051-0/+1
| | | | | | | | | | | | | | | | | | | | 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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc:it_IT: align Italian translationFederico Vaga2020-05-056-159/+287
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Translation for the following patches: commit c4f4af4094d6 ("docs: Add documentation for Symbol Namespaces") commit 36bc683dde0a ("kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'") commit a035d552a93b ("Makefile: Globally enable fall-through warning") commit b9918bdcac1f ("Documentation/process: Add fallthrough pseudo-keyword") commit 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst") commit fb0e0ffe7fc8 ("Documentation: bring process docs up to date") commit 7af51678b6d3 ("docs: deprecated.rst: Add BUG()-family") commit 7929b9836ed0 ("docs: Remove :c:func: from process/deprecated.rst") commit 76136e028d3b ("docs: deprecated.rst: Clean up fall-through details") commit d8401f504b49 ("docs: deprecated.rst: Add %p to the list") commit b1735296cef9 ("docs: locking: Drop :c:func: throughout") commit 6adb7755996f ("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.it Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: misc-device: add uacce to toctree(index)Vitor Massaru Iha2020-05-051-0/+1
| | | | | | | | | | | | | | | | | | | | This fixes: Documentation/misc-devices/uacce.rst: WARNING: document isn't included in any toctree Signed-off-by: Vitor Massaru Iha <vitor@massaru.org> Link: https://lore.kernel.org/r/20200430225828.114033-1-vitor@massaru.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kvm: Fix KVM_KVMCLOCK_CTRL API docJoshua Abraham2020-05-051-5/+7
| | | | | | | | | | | | | | | | | | | | 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-ZenBook Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * watchdog: update email address in conversion docWolfram Sang2020-05-051-1/+1
| | | | | | | | | | | | | | | | | | 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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * kobject: documentation: Fix erroneous function example in kobject doc.Qi Zheng2020-05-051-12/+14
| | | | | | | | | | | | | | | | | | 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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Merge branch 'mauro' into docs-nextJonathan Corbet2020-05-0554-3415/+3850
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
| | * docs: filesystems: convert configfs.txt to ReSTMauro Carvalho Chehab2020-05-057-58/+86
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: filesystems: convert xfs-self-describing-metadata.txt to ReSTMauro Carvalho Chehab2020-05-053-95/+98
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/7c26b200e12cfc07b9bd379612452d845a8d1474.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: filesystems: convert xfs-delayed-logging-design.txt to ReSTMauro Carvalho Chehab2020-05-053-28/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/2233c248f12e7b465cd27ee30a86f96eb632946a.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: filesystems: convert sysfs-tagging.txt to ReSTMauro Carvalho Chehab2020-05-052-8/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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/45a01fa5edd5c6ee8fc0754fc74f7ef65a3e5581.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: filesystems: convert sysfs-pci.txt to ReSTMauro Carvalho Chehab2020-05-052-8/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/2a9d307753c97d1a843341a2ef1993d43a407ded.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: filesystems: convert spufs/spu_run.txt to ReSTMauro Carvalho Chehab2020-05-052-24/+42
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/7d8ee1edf5ef0137009bc65ff0441826ce555895.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: filesystems: convert spufs/spufs.txt to ReSTMauro Carvalho Chehab2020-05-053-32/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/9ca05fad12390931bc7da0fa2502d1a450a4b87f.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: filesystems: convert spufs/spu_create.txt to ReSTMauro Carvalho Chehab2020-05-053-20/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/4d42e97d5560a79bd5dd443c592be04f9ae9a757.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>