Skip to content

Commit 0f4b928

Browse files
committed
Merge tag 'docs-5.15-2' of git://git.lwn.net/linux
Pull more documentation updates from Jonathan Corbet: "Another collection of documentation patches, mostly fixes but also includes another set of traditional Chinese translations" * tag 'docs-5.15-2' of git://git.lwn.net/linux: docs: pdfdocs: Fix typo in CJK-language specific font settings docs: kernel-hacking: Remove inappropriate text docs/zh_TW: add translations for zh_TW/filesystems docs/zh_TW: add translations for zh_TW/cpu-freq docs/zh_TW: add translations for zh_TW/arm64 docs/zh_CN: Modify the translator tag and fix the wrong word Documentation/features/vm: correct huge-vmap APIs Documentation: block: blk-mq: Fix small typo in multi-queue docs Documentation: in_irq() cleanup Documentation: arm: marvell: Add 88F6825 model into list Documentation/process/maintainer-pgp-guide: Replace broken link to PGP path finder Documentation: locking: fix references Documentation: Update details of The Linux Kernel Module Programming Guide docs: x86: Remove obsolete information about x86_64 vmalloc() faulting Documentation/process/applying-patches: Activate linux-next man hyperlink
2 parents 6dcaf9f + 7c5c18b commit 0f4b928

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+2686
-129
lines changed

Documentation/arm/marvell.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ EBU Armada family
140140
- 88F6821 Armada 382
141141
- 88F6W21 Armada 383
142142
- 88F6820 Armada 385
143+
- 88F6825
143144
- 88F6828 Armada 388
144145

145146
- Product infos: https://web.archive.org/web/20181006144616/http://www.marvell.com/embedded-processors/armada-38x/

Documentation/block/blk-mq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ layer or if we want to try to merge requests. In both cases, requests will be
5454
sent to the software queue.
5555

5656
Then, after the requests are processed by software queues, they will be placed
57-
at the hardware queue, a second stage queue were the hardware has direct access
57+
at the hardware queue, a second stage queue where the hardware has direct access
5858
to process those requests. However, if the hardware does not have enough
5959
resources to accept more requests, blk-mq will places requests on a temporary
6060
queue, to be sent in the future, when the hardware is able.

Documentation/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,8 +463,8 @@
463463
\\newcommand{\\kerneldocEndTC}{}
464464
\\newcommand{\\kerneldocBeginKR}{}
465465
\\newcommand{\\kerneldocEndKR}{}
466-
\\newcommand{\\kerneldocBeginSC}{}
467-
\\newcommand{\\kerneldocEndKR}{}
466+
\\newcommand{\\kerneldocBeginJP}{}
467+
\\newcommand{\\kerneldocEndJP}{}
468468
}
469469
'''
470470

Documentation/features/vm/huge-vmap/arch-support.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#
22
# Feature name: huge-vmap
33
# Kconfig: HAVE_ARCH_HUGE_VMAP
4-
# description: arch supports the ioremap_pud_enabled() and ioremap_pmd_enabled() VM APIs
4+
# description: arch supports the arch_vmap_pud_supported() and arch_vmap_pmd_supported() VM APIs
55
#
66
-----------------------
77
| arch |status|

Documentation/kernel-hacking/hacking.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ handler is never re-entered: if the same interrupt arrives, it is queued
7676
fast: frequently it simply acknowledges the interrupt, marks a 'software
7777
interrupt' for execution and exits.
7878

79-
You can tell you are in a hardware interrupt, because
80-
:c:func:`in_irq()` returns true.
79+
You can tell you are in a hardware interrupt, because in_hardirq() returns
80+
true.
8181

8282
.. warning::
8383

Documentation/kernel-hacking/locking.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,10 @@ primitives, but I'll pretend they don't exist.
9494
Locking in the Linux Kernel
9595
===========================
9696

97-
If I could give you one piece of advice: never sleep with anyone crazier
98-
than yourself. But if I had to give you advice on locking: **keep it
99-
simple**.
97+
If I could give you one piece of advice on locking: **keep it simple**.
10098

10199
Be reluctant to introduce new locks.
102100

103-
Strangely enough, this last one is the exact reverse of my advice when
104-
you **have** slept with someone crazier than yourself. And you should
105-
think about getting a big dog.
106-
107101
Two Main Types of Kernel Locks: Spinlocks and Mutexes
108102
-----------------------------------------------------
109103

@@ -1406,7 +1400,7 @@ bh
14061400
half will be running at any time.
14071401

14081402
Hardware Interrupt / Hardware IRQ
1409-
Hardware interrupt request. in_irq() returns true in a
1403+
Hardware interrupt request. in_hardirq() returns true in a
14101404
hardware interrupt handler.
14111405

14121406
Interrupt Context
@@ -1418,7 +1412,7 @@ SMP
14181412
(``CONFIG_SMP=y``).
14191413

14201414
Software Interrupt / softirq
1421-
Software interrupt handler. in_irq() returns false;
1415+
Software interrupt handler. in_hardirq() returns false;
14221416
in_softirq() returns true. Tasklets and softirqs both
14231417
fall into the category of 'software interrupts'.
14241418

Documentation/locking/futex-requeue-pi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Futex Requeue PI
55
Requeueing of tasks from a non-PI futex to a PI futex requires
66
special handling in order to ensure the underlying rt_mutex is never
77
left without an owner if it has waiters; doing so would break the PI
8-
boosting logic [see rt-mutex-desgin.txt] For the purposes of
8+
boosting logic [see rt-mutex-design.rst] For the purposes of
99
brevity, this action will be referred to as "requeue_pi" throughout
1010
this document. Priority inheritance is abbreviated throughout as
1111
"PI".

Documentation/locking/ww-mutex-design.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Wound/Wait Deadlock-Proof Mutex Design
33
======================================
44

5-
Please read mutex-design.txt first, as it applies to wait/wound mutexes too.
5+
Please read mutex-design.rst first, as it applies to wait/wound mutexes too.
66

77
Motivation for WW-Mutexes
88
-------------------------

Documentation/process/applying-patches.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ The -mm patches are experimental patches released by Andrew Morton.
389389

390390
In the past, -mm tree were used to also test subsystem patches, but this
391391
function is now done via the
392-
`linux-next <https://www.kernel.org/doc/man-pages/linux-next.html>`
392+
`linux-next` (https://www.kernel.org/doc/man-pages/linux-next.html)
393393
tree. The Subsystem maintainers push their patches first to linux-next,
394394
and, during the merge window, sends them directly to Linus.
395395

Documentation/process/kernel-docs.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,15 +126,17 @@ On-line docs
126126
describes how to write user-mode utilities for communicating with
127127
Card Services.
128128

129-
* Title: **Linux Kernel Module Programming Guide**
129+
* Title: **The Linux Kernel Module Programming Guide**
130130

131-
:Author: Ori Pomerantz.
132-
:URL: https://tldp.org/LDP/lkmpg/2.6/html/index.html
133-
:Date: 2001
131+
:Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram,
132+
Jim Huang.
133+
:URL: https://sysprog21.github.io/lkmpg/
134+
:Date: 2021
134135
:Keywords: modules, GPL book, /proc, ioctls, system calls,
135136
interrupt handlers .
136-
:Description: Very nice 92 pages GPL book on the topic of modules
137-
programming. Lots of examples.
137+
:Description: A very nice GPL book on the topic of modules
138+
programming. Lots of examples. Currently the new version is being
139+
actively maintained at https://github.com/sysprog21/lkmpg.
138140

139141
* Title: **Global spinlock list and usage**
140142

0 commit comments

Comments
 (0)