Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
+17
-14
+1
-1
Documentation/admin-guide/laptops/toshiba_haps.rst
+1
-1
Documentation/admin-guide/laptops/toshiba_haps.rst
···
43
43
==== =====================================================================
44
44
45
45
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,
47
47
given the fact that such drives have no movable parts, and thus, not requiring
48
48
any "protection" as well as failing during the evaluation of the _STA method
49
49
found under this device.
+3
-3
Documentation/core-api/rbtree.rst
+3
-3
Documentation/core-api/rbtree.rst
···
197
197
--------------
198
198
199
199
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
201
201
order for their own logic. To this end, users can use 'struct rb_root_cached'
202
202
to optimize O(logN) rb_first() calls to a simple pointer fetch avoiding
203
203
potentially expensive tree iterations. This is done at negligible runtime
···
255
255
256
256
When erasing a node, the user must call rb_erase_augmented() instead of
257
257
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.
259
259
260
260
In both cases, the callbacks are provided through struct rb_augment_callbacks.
261
261
3 callbacks must be defined:
···
293
293
294
294
This "extra information" stored in each node is the maximum hi
295
295
(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
297
297
and its immediate children. And this will be used in O(log n) lookup
298
298
for lowest match (lowest start address among all possible matches)
299
299
with something like::
+6
-6
Documentation/mm/page_tables.rst
+6
-6
Documentation/mm/page_tables.rst
···
26
26
the last page of physical memory the external address bus of the CPU can
27
27
address.
28
28
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
30
30
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
32
32
at 0x00004000, 0x00008000 ... 0xffffc000 and pfn goes from 0 to 0x3ffff.
33
33
34
34
As you can see, with 4KB pages the page base address uses bits 12-31 of the
···
38
38
Over time a deeper hierarchy has been developed in response to increasing memory
39
39
sizes. When Linux was created, 4KB pages and a single page table called
40
40
`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.
43
43
44
44
The software page table hierarchy reflects the fact that page table hardware has
45
45
become hierarchical and that in turn is done to save page table memory and
···
212
212
Additionally, page faults may be also caused by code bugs or by maliciously
213
213
crafted addresses that the CPU is instructed to access. A thread of a process
214
214
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
216
216
to a read-only location.
217
217
218
218
If the above-mentioned conditions happen in user-space, the kernel sends a
···
277
277
add that the page faults handler can be disabled and enabled respectively with
278
278
`pagefault_disable()` and `pagefault_enable()`.
279
279
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
281
281
disable traps into the page faults handler, mostly to prevent deadlocks.
+3
-1
Documentation/process/maintainer-pgp-guide.rst
+3
-1
Documentation/process/maintainer-pgp-guide.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
1
3
.. _pgpguide:
2
4
3
5
===========================
···
866
864
If you have a kernel.org account, then you should `add the kernel.org
867
865
UID to your key`_ to make WKD more useful to other kernel developers.
868
866
869
-
.. _`add the kernel.org UID to your key`: https://korg.wiki.kernel.org/userdoc/mail#adding_a_kernelorg_uid_to_your_pgp_key
867
+
.. _`add the kernel.org UID to your key`: https://korg.docs.kernel.org/mail.html#adding-a-kernel-org-uid-to-your-pgp-key
870
868
871
869
Web of Trust (WOT) vs. Trust on First Use (TOFU)
872
870
------------------------------------------------
+3
-3
Documentation/process/programming-language.rst
+3
-3
Documentation/process/programming-language.rst
···
3
3
Programming Language
4
4
====================
5
5
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]_
8
8
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
10
10
:ref:`Building Linux with Clang/LLVM <kbuild_llvm>`.
11
11
12
12
This dialect contains many extensions to the language [gnu-extensions]_,
+1
tools/lib/python/kdoc/kdoc_parser.py
+1
tools/lib/python/kdoc/kdoc_parser.py