Skip to content

Commit 26a4cfa

Browse files
committed
Merge tag 'docs-7.0-2' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux
Pull documentation fixes from Jonathan Corbet: "A handful of small, late-arriving documentation fixes" * tag 'docs-7.0-2' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux: docs: toshiba_haps: fix grammar error in SSD warning Docs/mm: fix typos and grammar in page_tables.rst Docs/core-api: fix typos in rbtree.rst docs: clarify wording in programming-language.rst docs: process: maintainer-pgp-guide: update kernel.org docs link docs: kdoc_parser: allow __exit in function prototypes
2 parents 011af61 + e1e828a commit 26a4cfa

File tree

6 files changed

+17
-14
lines changed

6 files changed

+17
-14
lines changed

Documentation/admin-guide/laptops/toshiba_haps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ RSSS Shuts down the HDD protection interface for a few seconds,
4343
==== =====================================================================
4444

4545
Note:
46-
The presence of Solid State Drives (SSD) can make this driver to fail loading,
46+
The presence of Solid State Drives (SSD) can cause this driver to fail loading,
4747
given the fact that such drives have no movable parts, and thus, not requiring
4848
any "protection" as well as failing during the evaluation of the _STA method
4949
found under this device.

Documentation/core-api/rbtree.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Cached rbtrees
197197
--------------
198198

199199
Computing the leftmost (smallest) node is quite a common task for binary
200-
search trees, such as for traversals or users relying on a the particular
200+
search trees, such as for traversals or users relying on the particular
201201
order for their own logic. To this end, users can use 'struct rb_root_cached'
202202
to optimize O(logN) rb_first() calls to a simple pointer fetch avoiding
203203
potentially expensive tree iterations. This is done at negligible runtime
@@ -255,7 +255,7 @@ affected subtrees.
255255

256256
When erasing a node, the user must call rb_erase_augmented() instead of
257257
rb_erase(). rb_erase_augmented() calls back into user provided functions
258-
to updated the augmented information on affected subtrees.
258+
to update the augmented information on affected subtrees.
259259

260260
In both cases, the callbacks are provided through struct rb_augment_callbacks.
261261
3 callbacks must be defined:
@@ -293,7 +293,7 @@ way making it possible to do efficient lookup and exact match.
293293

294294
This "extra information" stored in each node is the maximum hi
295295
(max_hi) value among all the nodes that are its descendants. This
296-
information can be maintained at each node just be looking at the node
296+
information can be maintained at each node just by looking at the node
297297
and its immediate children. And this will be used in O(log n) lookup
298298
for lowest match (lowest start address among all possible matches)
299299
with something like::

Documentation/mm/page_tables.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Physical memory address 0 will be *pfn 0* and the highest pfn will be
2626
the last page of physical memory the external address bus of the CPU can
2727
address.
2828

29-
With a page granularity of 4KB and a address range of 32 bits, pfn 0 is at
29+
With a page granularity of 4KB and an address range of 32 bits, pfn 0 is at
3030
address 0x00000000, pfn 1 is at address 0x00001000, pfn 2 is at 0x00002000
31-
and so on until we reach pfn 0xfffff at 0xfffff000. With 16KB pages pfs are
31+
and so on until we reach pfn 0xfffff at 0xfffff000. With 16KB pages pfns are
3232
at 0x00004000, 0x00008000 ... 0xffffc000 and pfn goes from 0 to 0x3ffff.
3333

3434
As you can see, with 4KB pages the page base address uses bits 12-31 of the
@@ -38,8 +38,8 @@ address, and this is why `PAGE_SHIFT` in this case is defined as 12 and
3838
Over time a deeper hierarchy has been developed in response to increasing memory
3939
sizes. When Linux was created, 4KB pages and a single page table called
4040
`swapper_pg_dir` with 1024 entries was used, covering 4MB which coincided with
41-
the fact that Torvald's first computer had 4MB of physical memory. Entries in
42-
this single table were referred to as *PTE*:s - page table entries.
41+
the fact that Torvalds's first computer had 4MB of physical memory. Entries in
42+
this single table were referred to as *PTEs* - page table entries.
4343

4444
The software page table hierarchy reflects the fact that page table hardware has
4545
become hierarchical and that in turn is done to save page table memory and
@@ -212,7 +212,7 @@ threshold.
212212
Additionally, page faults may be also caused by code bugs or by maliciously
213213
crafted addresses that the CPU is instructed to access. A thread of a process
214214
could use instructions to address (non-shared) memory which does not belong to
215-
its own address space, or could try to execute an instruction that want to write
215+
its own address space, or could try to execute an instruction that wants to write
216216
to a read-only location.
217217

218218
If the above-mentioned conditions happen in user-space, the kernel sends a
@@ -277,5 +277,5 @@ To conclude this high altitude view of how Linux handles page faults, let's
277277
add that the page faults handler can be disabled and enabled respectively with
278278
`pagefault_disable()` and `pagefault_enable()`.
279279

280-
Several code path make use of the latter two functions because they need to
280+
Several code paths make use of the latter two functions because they need to
281281
disable traps into the page faults handler, mostly to prevent deadlocks.

Documentation/process/maintainer-pgp-guide.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
13
.. _pgpguide:
24

35
===========================
@@ -864,7 +866,7 @@ don't already have them)::
864866
If you have a kernel.org account, then you should `add the kernel.org
865867
UID to your key`_ to make WKD more useful to other kernel developers.
866868

867-
.. _`add the kernel.org UID to your key`: https://korg.wiki.kernel.org/userdoc/mail#adding_a_kernelorg_uid_to_your_pgp_key
869+
.. _`add the kernel.org UID to your key`: https://korg.docs.kernel.org/mail.html#adding-a-kernel-org-uid-to-your-pgp-key
868870

869871
Web of Trust (WOT) vs. Trust on First Use (TOFU)
870872
------------------------------------------------

Documentation/process/programming-language.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
Programming Language
44
====================
55

6-
The kernel is written in the C programming language [c-language]_.
7-
More precisely, the kernel is typically compiled with ``gcc`` [gcc]_
6+
The Linux kernel is written in the C programming language [c-language]_.
7+
More precisely, it is typically compiled with ``gcc`` [gcc]_
88
under ``-std=gnu11`` [gcc-c-dialect-options]_: the GNU dialect of ISO C11.
9-
``clang`` [clang]_ is also supported, see docs on
9+
``clang`` [clang]_ is also supported; see documentation on
1010
:ref:`Building Linux with Clang/LLVM <kbuild_llvm>`.
1111

1212
This dialect contains many extensions to the language [gnu-extensions]_,

tools/lib/python/kdoc/kdoc_parser.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@
175175
(KernRe(r"^__FORTIFY_INLINE +"), ""),
176176
(KernRe(r"__init +"), ""),
177177
(KernRe(r"__init_or_module +"), ""),
178+
(KernRe(r"__exit +"), ""),
178179
(KernRe(r"__deprecated +"), ""),
179180
(KernRe(r"__flatten +"), ""),
180181
(KernRe(r"__meminit +"), ""),

0 commit comments

Comments
 (0)