aboutsummaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2020-08-13Documentation/locking/locktypes: fix the typoHuang Shijie1-1/+1
We have three categories locks, not two. Signed-off-by: Huang Shijie <[email protected]> Acked-by: Will Deacon <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11doc/zh_CN: resolve undefined label warning in admin-guide indexLukas Bulwahn1-1/+1
Documentation generation warns: Documentation/translations/zh_CN/admin-guide/index.rst:3: WARNING: undefined label: documentation/admin-guide/index.rst Use doc reference for .rst files to resolve the warning. Fixes: 37a607cf2318 ("doc/zh_CN: add admin-guide index") Signed-off-by: Lukas Bulwahn <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11doc/zh_CN: fix title heading markup in admin-guide cpu-loadLukas Bulwahn1-2/+2
Documentation generation warns: Documentation/translations/zh_CN/admin-guide/cpu-load.rst:1: WARNING: Title overline too short. Extend title heading markup by one. It was just off by one. Fixes: e210c66d567c ("doc/zh_CN: add cpu-load Chinese version") Signed-off-by: Lukas Bulwahn <[email protected]> Acked-by: Tao Zhou <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11docs: remove the 2.6 "Upgrading I2C Drivers" guideStephen Kitt2-286/+0
All the drivers have long since been upgraded, and all the important information here is also included in the "Implementing I2C device drivers" guide. Signed-off-by: Stephen Kitt <[email protected]> Reviewed-by: Wolfram Sang <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11docs: Correct the release date of 5.2 stableBilly Wilson1-1/+1
A table lists the 5.2 stable release date as September 15, but it was released on July 7. This may confuse a reader who is trying to understand the stable update release cycle. Signed-off-by: Billy Wilson <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11mailmap: Update comments for with format and more detalisKees Cook1-2/+7
Without having first read the git-shortlog man-page, the format of .mailmap may not be immediately obvious. Add comments with pointers to the man-page, along with other details. Signed-off-by: Kees Cook <[email protected]> Link: https://lore.kernel.org/r/202008080013.58EBD83@keescook Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11docs: cdrom: Fix a typo and rst markupRemi Andruccioli1-2/+2
"The capability fags" should be "The capability flags". In rst markup, a incorrect markup expression is causing bad rendering in Sphinx output. Replace the erroneous single quote by a backquote. Signed-off-by: Remi Andruccioli <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11Doc: admin-guide: use correct legends in kernel-parameters.txtRandy Dunlap1-18/+18
Documentation/admin-guide/kernel-parameters.rst includes a legend telling us what configurations or hardware platforms are relevant for certain boot options. For X86, it is spelled "X86" and for x86_64, it is spelled "X86-64", so make corrections for those. Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: Thomas Gleixner <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: Borislav Petkov <[email protected]> Cc: [email protected] Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11Documentation/features: refresh RISC-V arch support filesTobias Klauser4-4/+4
Support for these was added by the following commits: f2c9699f6555 ("riscv: Add STACKPROTECTOR supported") 3c4697982982 ("riscv: Enable LOCKDEP_SUPPORT & fixup TRACE_IRQFLAGS_SUPPORT"). ed48b297fe21 ("riscv: Enable context tracking") cbb3d91d3bcf ("riscv: Add kmemleak support") Signed-off-by: Tobias Klauser <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11documentation: coccinelle: Improve command example for make C={1,2}Sumera Priyadarsini1-4/+11
Modify coccinelle documentation to further clarify the usage of the makefile C variable by coccicheck. Signed-off-by: Sumera Priyadarsini <[email protected]> Acked-by: Julia Lawall <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11Core-api: Documentation: Replace deprecated :c:func: UsagePuranjay Mohan1-16/+16
Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan <[email protected]> Reviewed-by: Matthew Wilcox (Oracle) <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11Dev-tools: Documentation: Replace deprecated :c:func: UsagePuranjay Mohan1-8/+8
Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11Filesystems: Documentation: Replace deprecated :c:func: UsagePuranjay Mohan1-33/+33
Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-08-11docs: trace: fix a typoBryan Brattlof1-1/+1
emumerated -> enumerated Signed-off-by: Bryan Brattlof <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-31scripts/kernel-doc: optionally treat warnings as errorsPierre-Louis Bossart1-1/+22
The kbuild bot recently added the W=1 option, which triggered documentation cleanups to squelch hundreds of kernel-doc warnings. To make sure new kernel contributions don't add regressions to kernel-doc descriptors, this patch suggests an option to treat warnings as errors in CI/automated tests. A -Werror command-line option is added to the kernel-doc script. When this option is set, the script will return the number of warnings found. The caller can then treat this positive return value as an error and stop the build. Using this command line option is however not straightforward when the kernel-doc script is called from other scripts. To align with typical kernel compilation or documentation generation, the Werror option is also set by checking the KCFLAGS environment variable, or if KDOC_WERROR is defined, as in the following examples: KCFLAGS="-Wall -Werror" make W=1 sound/ KCFLAGS="-Wall -Werror" make W=1 drivers/soundwire/ KDOC_WERROR=1 make htmldocs Note that in the last example the documentation build does not stop, only an additional log is provided. Credits to Randy Dunlap for suggesting the use of environment variables. Suggested-by: Randy Dunlap <[email protected]> Signed-off-by: Pierre-Louis Bossart <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-31docs: ia64: correct typoJulia Lawall1-1/+1
Replace RTC_WKLAM_RD with RTC_WKALM_RD. Signed-off-by: Julia Lawall <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-31mailmap: add entry for <[email protected]>Alexander Lobakin1-0/+1
My Marvell account has been suspended, map the address to my private mail. Signed-off-by: Alexander Lobakin <[email protected]> Link: https://lore.kernel.org/r/9xzFiqHAFGYuKfUycRaCQSIgsqmeL9E9SA3lSoqOMUPhFVaAgSgvukCUWO7iRbjtiUrFjK46fhu7dJ5TaCv1EjaNFm5yF_H3y5S1s_QALCA=@pm.me Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27doc/zh_CN: add cpu-load Chinese versionTao Zhou2-1/+106
Add cpu-load Chinese version and link it into admin-guide. Based on Alex's recent thread: https://lkml.kernel.org/r/[email protected] Reviewed-by: Alex Shi <[email protected]> Signed-off-by: Tao Zhou <[email protected]> Link: https://lore.kernel.org/r/BL0PR14MB37798BBF2307910DE73EF6D49A770@BL0PR14MB3779.namprd14.prod.outlook.com Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27Documentation/admin-guide: tainted-kernels: fix spelling mistakeYue Hu1-1/+1
Fix typo "tis" -> "this". Signed-off-by: Yue Hu <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27MAINTAINERS: adjust kprobes.rst entry to new locationLukas Bulwahn1-1/+1
Commit 2165b82fde82 ("docs: Move kprobes.rst from staging/ to trace/") moved kprobes.rst, but missed to adjust the MAINTAINERS entry. Hence, ./scripts/get_maintainer.pl --self-test=patterns complains: warning: no file matches F: Documentation/staging/kprobes.rst Adjust the entry to the new file location. Signed-off-by: Lukas Bulwahn <[email protected]> Acked-by: Naveen N. Rao <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27devices.txt: document rfkill allocationPavel Machek1-1/+2
Document rfkill allocation. Signed-off-by: Pavel Machek (CIP) <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27PCI: correct flag nameJulia Lawall1-1/+1
RESOURCE_IO does not exist. Rename to IORESOURCE_IO. Signed-off-by: Julia Lawall <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27docs: filesystems: vfs: correct flag nameJulia Lawall1-1/+1
There is no flag REMAP_CAN_SHORTEN. Commit eca3654e3cc7 ("vfs: enable remap callers that can handle short operations") that introduces this text also introduces the flag REMAP_FILE_CAN_SHORTEN. Change the name in the documentation accordingly. Signed-off-by: Julia Lawall <[email protected]> Fixes: eca3654e3cc7 ("vfs: enable remap callers that can handle short operations") Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27docs: filesystems: vfs: correct sync_mode flag namesJulia Lawall1-2/+2
Change the nonexistent flag names WBC_SYNC_ALL and WBC_SYNC_NONE to WB_SYNC_ALL and WB_SYNC_NONE, respectively, as used in the code with wbc->sync_mode. Signed-off-by: Julia Lawall <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27docs: path-lookup: markup fixes for emphasisVegard Nossum1-4/+4
Underscores were being used for emphasis, but these are rendered verbatim in HTML output. reStructuredText uses asterisks for emphasis. I *think* I caught all of them. Signed-off-by: Vegard Nossum <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27docs: path-lookup: more markup fixesVegard Nossum1-5/+5
"xxx``at``" makes the `` appear verbatim in the HTML output. I've opted for changing this into ``*at()`` to harmonise this with the use of * seen later in the same document (and add the parentheses to clarify that this is a system/function call). ``path_``* also makes `` appear in the HTML output, but we can fix it by moving the * into the ``. Also add the parantheses here. Signed-off-by: Vegard Nossum <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-27docs: path-lookup: fix HTML entity mojibakeVegard Nossum1-3/+3
Two cases of "<" somehow turned into "&lt;". I noticed it on <https://www.kernel.org/doc/html/latest/filesystems/path-lookup.html>. I've verified that the HTML output is correct with this patch. Signed-off-by: Vegard Nossum <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23CREDITS: Replace HTTP links with HTTPS onesAlexander A. Klimov1-36/+36
Rationale: Reduces attack surface on kernel devs opening the links for MITM as HTTPS traffic is much harder to manipulate. Deterministic algorithm: For each file: If not .svg: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS. Signed-off-by: Alexander A. Klimov <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: process: Add an example for creating a fixes tagTom Rix1-0/+5
To make it a little clearer how to create a fixes tag, add an example based on the preceeding gitconfig setup. Signed-off-by: Tom Rix <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23doc/zh_CN: add Chinese translation prefer sectionAlex Shi1-0/+3
The add words is: Tranlation plan: Welcome for any part of kernel doc Chinese translation, expecially for admin-guide part. Signed-off-by: Alex Shi <[email protected]> Cc: Harry Wei <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: [email protected] Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23doc/zh_CN: add clearing-warn-once Chinese versionAlex Shi2-1/+23
and link it into admin-guide. Signed-off-by: Alex Shi <[email protected]> Cc: Harry Wei <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: [email protected] Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23doc/zh_CN: add admin-guide indexAlex Shi2-0/+113
Translate the admin-guide index.rst file into Chinese. and link it into Chinese top index file. Signed-off-by: Alex Shi <[email protected]> Cc: Harry Wei <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: [email protected] Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23doc:it_IT: process: coding-style.rst: Correct __maybe_unused compiler labelLee Jones1-1/+1
Flag is __maybe_unused, not __maybe_used. Cc: Federico Vaga <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: [email protected] Signed-off-by: Lee Jones <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23futex: MAINTAINERS: Re-add selftests directoryAndré Almeida1-1/+1
Commit 95ca6d73a8a97 ("docs: move locking-specific documents to locking/") accidentally replaced the selftests line for a duplicated documentation one. Revert this change. Signed-off-by: André Almeida <[email protected]> Fixes: 95ca6d73a8a97 ("docs: move locking-specific documents to locking/") Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: timers: drop documentation about LB_BIASJulia Lawall1-2/+0
The LB_BIAS feature was removed in commit 1c1b8a7b03ef ("sched/fair: Replace source_load() & target_load() with weighted_cpuload()"), so drop the mention that it is disabled in the no_hz case. Signed-off-by: Julia Lawall <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: core-api/printk-formats.rst: use literal block syntaxDaniel W. S. Almeida1-1/+3
Fix the following warning: WARNING: Definition list ends without a blank line; unexpected unindent. By switching to the literal block syntax. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: bpf/bpf_devel_QA.rst: fix reference to nonexistent documentDaniel W. S. Almeida1-0/+1
Fix the following sphinx warning: bpf_devel_QA.rst:444: WARNING: Unknown target name: "documentation/bpf/btf.rst" No target was defined for 'btf.rst' in the document. Fix it. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: process/index.rst: Fix reference to nonexistent documentDaniel W. S. Almeida1-2/+2
Fix the following warning: WARNING: toctree contains reference to nonexistent document 'process/unaligned-memory-access' The path to the document was wrong. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: staging/tee.rst: convert into definition listDaniel W. S. Almeida1-7/+11
Fix the following warnings: tee.rst:65: WARNING: Unexpected indentation. tee.rst:69: WARNING: Block quote ends without a blank line; unexpected unindent. By switching to the 'definition list' syntax. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: admin-guide/mm/index: Fix reference to nonexistent documentDaniel W. S. Almeida1-1/+1
Fix the following warning: WARNING: toctree contains reference to nonexistent document 'admin-guide/mm/nommu-map' This was due to a typo. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: admin-guide/index.rst: Add pstore-blk.rstDaniel W. S. Almeida1-0/+1
Fix the following warning: Documentation/admin-guide/pstore-blk.rst: WARNING: document isn't included in any toctree By adding 'pstore-blk.rst' to the index Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Acked-by: Kees Cook <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: bpf/index.rst: Add ringbuf.rstDaniel W. S. Almeida1-0/+8
Fix the following warning Documentation/bpf/ringbuf.rst: WARNING: document isn't included in any toctree By adding it to the index. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: trace/index.rst: add histogram-design.rstDaniel W. S. Almeida1-0/+1
Fix the following warning: Documentation/trace/histogram-design.rst: WARNING: document isn't included in any toctree By adding 'histogram-design.rst' to the index. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: index.rst: Add watch_queueDaniel W. S. Almeida1-0/+1
Fix the following sphinx warning: Documentation/watch_queue.rst: WARNING: document isn't included in any toctree By adding watch_queue.rst to the index. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs/core-api: memory-allocation: describe reclaim behaviourMike Rapoport1-0/+44
Changelog of commit dcda9b04713c ("mm, tree wide: replace __GFP_REPEAT by __GFP_RETRY_MAYFAIL with more useful semantic") has very nice description of GFP flags that affect reclaim behaviour of the page allocator. It would be pity to keep this description buried in the log so let's expose it in the Documentation/ as well. Cc: Michal Hocko <[email protected]> Acked-by: Michal Hocko <[email protected]> Signed-off-by: Mike Rapoport <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23Documentation: driver-api: update kernel connectorWang Long1-2/+3
This patch changes: 1) Fix typo in kernel connector documentation. s/cn_netlink_send_multi/cn_netlink_send_mult/ 2) update definition of struct cn_msg Signed-off-by: Wang Long <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23arm64: Replace HTTP links with HTTPS onesAlexander A. Klimov1-1/+1
Rationale: Reduces attack surface on kernel devs opening the links for MITM as HTTPS traffic is much harder to manipulate. Deterministic algorithm: For each file: If not .svg: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS. Signed-off-by: Alexander A. Klimov <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs/mm: concepts.rst: remove unnecessary wordBhaskar Chowdhury1-1/+1
Signed-off-by: Bhaskar Chowdhury <[email protected]> Acked-by: Mike Rapoport <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: Move kprobes.rst from staging/ to trace/Naveen N. Rao3-1/+1
Kprobes contitutes a dynamic tracing technology and as such can be moved alongside documentation of other tracing technologies. Signed-off-by: Naveen N. Rao <[email protected]> Acked-by: Masami Hiramatsu <[email protected]> Link: https://lore.kernel.org/r/8a09c01c64b2e003d5486c4f0c89740618f1bae4.1595331824.git.naveen.n.rao@linux.vnet.ibm.com Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-23docs: staging/kprobes.rst: Move references to a separate appendixNaveen N. Rao1-5/+9
Kprobes references are currently listed right after kretprobes example, and appears to be part of the same section. Move this out to a separate appendix for clarity. Signed-off-by: Naveen N. Rao <[email protected]> Acked-by: Masami Hiramatsu <[email protected]> Link: https://lore.kernel.org/r/2bba61cd60eec87fbcca3e4343b7f95afa1178cd.1595331824.git.naveen.n.rao@linux.vnet.ibm.com Signed-off-by: Jonathan Corbet <[email protected]>
Powered by cgit, Gruvboxed by Blaster4385.