Skip to content

Commit c3cda60

Browse files
committed
Merge tag 'docs-6.13' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "Another moderately busy cycle in docsland: - Work on Chinese translations has picked up again. Happily, they are maintaining the existing translations and not just adding new ones. - Some maintenance of the Japanese and Italian translations as well. - The removal of the venerable "dontdiff" file. It has long outlived its usefulness and contained entries ("parse.*") that would actively mask actual source change. - The addition of enforcement information to the code-of-conduct documentation. Along with some build-system fixes and a lot of typo and language fixes" * tag 'docs-6.13' of git://git.lwn.net/linux: (52 commits) Documentation/CoC: spell out enforcement for unacceptable behaviors docs: fix typos and whitespace in Documentation/process/backporting.rst docs/zh_CN: fix one sentence in llvm.rst docs: bug-bisect: add a note about bisecting -next docs/zh_CN: add the translation of kbuild/llvm.rst Documentation: Fix incorrect paths/magic in magic numbers rst Documentation/maintainer-tip: Fix typos Documentation: Improve crash_kexec_post_notifiers description Docs/zh_CN: Translate physical_memory.rst to Simplified Chinese Documentation: admin: reorganize kernel-parameters intro docs/zh_CN: update the translation of process/programming-language.rst docs/zh_CN: update the translation of mm/page_owner.rst docs/zh_CN: update the translation of mm/page_table_check.rst docs/zh_CN: update the translation of mm/overcommit-accounting.rst docs/zh_CN: update the translation of mm/admon/faq.rst docs/zh_CN: update the translation of mm/active_mm.rst docs/zh_CN: update the translation of mm/hmm.rst docs: remove Documentation/dontdiff docs/zh_CN: Add a entry in Chinese glossary Docs/zh_CN: Fix the pfn calculation error in page_tables.rst ...
2 parents bf9aa14 + c818d5c commit c3cda60

Some content is hidden

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

68 files changed

+2892
-657
lines changed

.mailmap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -730,6 +730,7 @@ Will Deacon <will@kernel.org> <will.deacon@arm.com>
730730
Wolfram Sang <wsa@kernel.org> <w.sang@pengutronix.de>
731731
Wolfram Sang <wsa@kernel.org> <wsa@the-dreams.de>
732732
Yakir Yang <kuankuan.y@gmail.com> <ykk@rock-chips.com>
733+
Yanteng Si <si.yanteng@linux.dev> <siyanteng@loongson.cn>
733734
Yusuke Goda <goda.yusuke@renesas.com>
734735
Zack Rusin <zack.rusin@broadcom.com> <zackr@vmware.com>
735736
Zhu Yanjun <zyjzyj2000@gmail.com> <yanjunz@nvidia.com>

Documentation/admin-guide/bug-bisect.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,27 @@ a fully reliable and straight-forward way to reproduce the regression, too.*
108108
With that the process is complete. Now report the regression as described by
109109
Documentation/admin-guide/reporting-issues.rst.
110110

111+
Bisecting linux-next
112+
--------------------
113+
114+
If you face a problem only happening in linux-next, bisect between the
115+
linux-next branches 'stable' and 'master'. The following commands will start
116+
the process for a linux-next tree you added as a remote called 'next'::
117+
118+
git bisect start
119+
git bisect good next/stable
120+
git bisect bad next/master
121+
122+
The 'stable' branch refers to the state of linux-mainline that the current
123+
linux-next release (found in the 'master' branch) is based on -- the former
124+
thus should be free of any problems that show up in -next, but not in Linus'
125+
tree.
126+
127+
This will bisect across a wide range of changes, some of which you might have
128+
used in earlier linux-next releases without problems. Sadly there is no simple
129+
way to avoid checking them: bisecting from one linux-next release to a later
130+
one (say between 'next-20241020' and 'next-20241021') is impossible, as they
131+
share no common history.
111132

112133
Additional reading material
113134
---------------------------

Documentation/admin-guide/kernel-parameters.rst

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ kernel command line (/proc/cmdline) and collects module parameters
2727
when it loads a module, so the kernel command line can be used for
2828
loadable modules too.
2929

30+
This document may not be entirely up to date and comprehensive. The command
31+
"modinfo -p ${modulename}" shows a current list of all parameters of a loadable
32+
module. Loadable modules, after being loaded into the running kernel, also
33+
reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
34+
parameters may be changed at runtime by the command
35+
``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
36+
37+
Special handling
38+
----------------
39+
3040
Hyphens (dashes) and underscores are equivalent in parameter names, so::
3141

3242
log_buf_len=1M print-fatal-signals=1
@@ -39,8 +49,8 @@ Double-quotes can be used to protect spaces in values, e.g.::
3949

4050
param="spaces in here"
4151

42-
cpu lists:
43-
----------
52+
cpu lists
53+
~~~~~~~~~
4454

4555
Some kernel parameters take a list of CPUs as a value, e.g. isolcpus,
4656
nohz_full, irqaffinity, rcu_nocbs. The format of this list is:
@@ -82,12 +92,17 @@ so that "nohz_full=all" is the equivalent of "nohz_full=0-N".
8292
The semantics of "N" and "all" is supported on a level of bitmaps and holds for
8393
all users of bitmap_parselist().
8494

85-
This document may not be entirely up to date and comprehensive. The command
86-
"modinfo -p ${modulename}" shows a current list of all parameters of a loadable
87-
module. Loadable modules, after being loaded into the running kernel, also
88-
reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
89-
parameters may be changed at runtime by the command
90-
``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
95+
Metric suffixes
96+
~~~~~~~~~~~~~~~
97+
98+
The [KMG] suffix is commonly described after a number of kernel
99+
parameter values. 'K', 'M', 'G', 'T', 'P', and 'E' suffixes are allowed.
100+
These letters represent the _binary_ multipliers 'Kilo', 'Mega', 'Giga',
101+
'Tera', 'Peta', and 'Exa', equaling 2^10, 2^20, 2^30, 2^40, 2^50, and
102+
2^60 bytes respectively. Such letter suffixes can also be entirely omitted.
103+
104+
Kernel Build Options
105+
--------------------
91106

92107
The parameters listed below are only valid if certain kernel build options
93108
were enabled and if respective hardware is present. This list should be kept
@@ -211,10 +226,5 @@ a fixed number of characters. This limit depends on the architecture
211226
and is between 256 and 4096 characters. It is defined in the file
212227
./include/uapi/asm-generic/setup.h as COMMAND_LINE_SIZE.
213228

214-
Finally, the [KMG] suffix is commonly described after a number of kernel
215-
parameter values. These 'K', 'M', and 'G' letters represent the _binary_
216-
multipliers 'Kilo', 'Mega', and 'Giga', equaling 2^10, 2^20, and 2^30
217-
bytes respectively. Such letter suffixes can also be entirely omitted:
218-
219229
.. include:: kernel-parameters.txt
220230
:literal:

Documentation/admin-guide/kernel-parameters.txt

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -921,12 +921,16 @@
921921
the parameter has no effect.
922922

923923
crash_kexec_post_notifiers
924-
Run kdump after running panic-notifiers and dumping
925-
kmsg. This only for the users who doubt kdump always
926-
succeeds in any situation.
927-
Note that this also increases risks of kdump failure,
928-
because some panic notifiers can make the crashed
929-
kernel more unstable.
924+
Only jump to kdump kernel after running the panic
925+
notifiers and dumping kmsg. This option increases
926+
the risks of a kdump failure, since some panic
927+
notifiers can make the crashed kernel more unstable.
928+
In configurations where kdump may not be reliable,
929+
running the panic notifiers could allow collecting
930+
more data on dmesg, like stack traces from other CPUS
931+
or extra data dumped by panic_print. Note that some
932+
configurations enable this option unconditionally,
933+
like Hyper-V, PowerPC (fadump) and AMD SEV-SNP.
930934

931935
crashkernel=size[KMG][@offset[KMG]]
932936
[KNL,EARLY] Using kexec, Linux can switch to a 'crash kernel'
@@ -6882,6 +6886,12 @@
68826886

68836887
reserve_mem=12M:4096:trace trace_instance=boot_map^traceoff^traceprintk@trace,sched,irq
68846888

6889+
Note, saving the trace buffer across reboots does require that the system
6890+
is set up to not wipe memory. For instance, CONFIG_RESET_ATTACK_MITIGATION
6891+
can force a memory reset on boot which will clear any trace that was stored.
6892+
This is just one of many ways that can clear memory. Make sure your system
6893+
keeps the content of memory across reboots before relying on this option.
6894+
68856895
See also Documentation/trace/debugging.rst
68866896

68876897

Documentation/core-api/cpu_hotplug.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ ONLINE section for notifications on online and offline operation::
616616
....
617617
cpuhp_remove_instance(state, &inst2->node);
618618
....
619-
remove_multi_state(state);
619+
cpuhp_remove_multi_state(state);
620620

621621

622622
Testing of hotplug states

Documentation/core-api/swiotlb.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,9 +295,9 @@ slot set.
295295

296296
Fourth, the io_tlb_slot array keeps track of any "padding slots" allocated to
297297
meet alloc_align_mask requirements described above. When
298-
swiotlb_tlb_map_single() allocates bounce buffer space to meet alloc_align_mask
298+
swiotlb_tbl_map_single() allocates bounce buffer space to meet alloc_align_mask
299299
requirements, it may allocate pre-padding space across zero or more slots. But
300-
when swiotbl_tlb_unmap_single() is called with the bounce buffer address, the
300+
when swiotlb_tbl_unmap_single() is called with the bounce buffer address, the
301301
alloc_align_mask value that governed the allocation, and therefore the
302302
allocation of any padding slots, is not known. The "pad_slots" field records
303303
the number of padding slots so that swiotlb_tbl_unmap_single() can free them.

Documentation/dev-tools/gcov.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Possible uses:
2323
associated code is never run?)
2424

2525
.. _gcov: https://gcc.gnu.org/onlinedocs/gcc/Gcov.html
26-
.. _lcov: http://ltp.sourceforge.net/coverage/lcov.php
26+
.. _lcov: https://github.com/linux-test-project/lcov
2727

2828

2929
Preparation

Documentation/dev-tools/kgdb.rst

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ supports it for the architecture you are using, you can use hardware
7575
breakpoints if you desire to run with the ``CONFIG_STRICT_KERNEL_RWX``
7676
option turned on, else you need to turn off this option.
7777

78-
Next you should choose one of more I/O drivers to interconnect debugging
78+
Next you should choose one or more I/O drivers to interconnect the debugging
7979
host and debugged target. Early boot debugging requires a KGDB I/O
8080
driver that supports early debugging and the driver must be built into
8181
the kernel directly. Kgdb I/O driver configuration takes place via
82-
kernel or module parameters which you can learn more about in the in the
82+
kernel or module parameters which you can learn more about in the
8383
section that describes the parameter kgdboc.
8484

8585
Here is an example set of ``.config`` symbols to enable or disable for kgdb::
@@ -201,8 +201,8 @@ Using loadable module or built-in
201201
Configure kgdboc at runtime with sysfs
202202
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
203203

204-
At run time you can enable or disable kgdboc by echoing a parameters
205-
into the sysfs. Here are two examples:
204+
At run time you can enable or disable kgdboc by writing parameters
205+
into sysfs. Here are two examples:
206206

207207
1. Enable kgdboc on ttyS0::
208208

@@ -329,7 +329,7 @@ ways to activate this feature.
329329

330330
2. Use sysfs before configuring an I/O driver::
331331

332-
echo 1 > /sys/module/kgdb/parameters/kgdb_use_con
332+
echo 1 > /sys/module/debug_core/parameters/kgdb_use_con
333333

334334
.. note::
335335

@@ -374,10 +374,10 @@ default behavior is always set to 0.
374374
Kernel parameter: ``nokaslr``
375375
-----------------------------
376376

377-
If the architecture that you are using enable KASLR by default,
377+
If the architecture that you are using enables KASLR by default,
378378
you should consider turning it off. KASLR randomizes the
379-
virtual address where the kernel image is mapped and confuse
380-
gdb which resolve kernel symbol address from symbol table
379+
virtual address where the kernel image is mapped and confuses
380+
gdb which resolves addresses of kernel symbols from the symbol table
381381
of vmlinux.
382382

383383
Using kdb
@@ -631,8 +631,6 @@ automatically changes into kgdb mode.
631631

632632
kgdb
633633

634-
Now disconnect your terminal program and connect gdb in its place
635-
636634
2. At the kdb prompt, disconnect the terminal program and connect gdb in
637635
its place.
638636

@@ -749,7 +747,7 @@ The kernel debugger is organized into a number of components:
749747
helper functions in some of the other kernel components to make it
750748
possible for kdb to examine and report information about the kernel
751749
without taking locks that could cause a kernel deadlock. The kdb core
752-
contains implements the following functionality.
750+
implements the following functionality.
753751

754752
- A simple shell
755753

Documentation/dev-tools/kmsan.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ KMSAN shadow memory
133133
-------------------
134134

135135
KMSAN associates a metadata byte (also called shadow byte) with every byte of
136-
kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
136+
kernel memory. A bit in the shadow byte is set if the corresponding bit of the
137137
kernel memory byte is uninitialized. Marking the memory uninitialized (i.e.
138138
setting its shadow bytes to ``0xff``) is called poisoning, marking it
139139
initialized (setting the shadow bytes to ``0x00``) is called unpoisoning.

0 commit comments

Comments
 (0)