Skip to content

Commit cf05e93

Browse files
torvaldstorvalds
committed
Merge tag 'docs-6.11' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "Nothing hugely exciting happening in the documentation tree this time around, mostly more of the usual: - More Spanish, Italian, and Chinese translations - A new script, scripts/checktransupdate.py, can be used to see which commits have touched an (English) document since a given translation was last updated. - A couple of "best practices" suggestions (on Link: tags and off-list discussions) that were not entirely at consensus level, but I concluded they were close enough to accept. - Some nice cleanups removing documentation for kernel parameters that have not been recognized for ... a long time. ...along with the usual updates, typo fixes, and such" * tag 'docs-6.11' of git://git.lwn.net/linux: (57 commits) Documentation: Document user_events ioctl code docs/pinctrl: fix typo in mapping example docs: maintainer: discourage taking conversations off-list docs: driver-model: platform: update the definition of platform_driver docs/sp_SP: Add translation for scheduler/sched-design-CFS.rst writing_musb_glue_layer.rst: Fix broken URL zh_CN/admin-guide: one typo fix docs/zh_CN/virt: Update the translation of guest-halt-polling.rst Documentation: add reference from dynamic debug to loglevel kernel params Documentation: best practices for using Link trailers Documentation: fix links to mailing list services Documentation: exception-tables.rst: Fix the wrong steps referenced docs/zh_CN: add process/researcher-guidelines Chinese translation Documentation/tools/rv: fix document header docs/sp_SP: Add translation of process/maintainer-kvm-x86.rst docs/admin-guide/mm: correct typo 'quired' to 'queried' Add libps2 to the input section of driver-api Docs/mm/index: move allocation profiling document to unsorted documents chapter Docs/mm/index: rename 'Legacy Documentation' to 'Unsorted Documentation' Docs/mm/index: Remove 'Memory Management Guide' chapter marker ...
2 parents 7dd894c + 702418f commit cf05e93

File tree

77 files changed

+1976
-419
lines changed

Some content is hidden

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

77 files changed

+1976
-419
lines changed

‎.clang-format

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#
55
# For more information, see:
66
#
7-
# Documentation/process/clang-format.rst
7+
# Documentation/dev-tools/clang-format.rst
88
# https://clang.llvm.org/docs/ClangFormat.html
99
# https://clang.llvm.org/docs/ClangFormatStyleOptions.html
1010
#

‎Documentation/admin-guide/dynamic-debug-howto.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ Dynamic debug provides:
2626
- format string
2727
- class name (as known/declared by each module)
2828

29+
NOTE: To actually get the debug-print output on the console, you may
30+
need to adjust the kernel ``loglevel=``, or use ``ignore_loglevel``.
31+
Read about these kernel parameters in
32+
Documentation/admin-guide/kernel-parameters.rst.
33+
2934
Viewing Dynamic Debug Behaviour
3035
===============================
3136

‎Documentation/admin-guide/kernel-parameters.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@ is applicable::
118118
HIBERNATION HIBERNATION is enabled.
119119
HW Appropriate hardware is enabled.
120120
HYPER_V HYPERV support is enabled.
121-
IA-64 IA-64 architecture is enabled.
122121
IMA Integrity measurement architecture is enabled.
123122
IP_PNP IP DHCP, BOOTP, or RARP is enabled.
124123
IPV6 IPv6 support is enabled.

‎Documentation/admin-guide/kernel-parameters.txt

Lines changed: 4 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1742,8 +1742,6 @@
17421742
for 64-bit NUMA, off otherwise.
17431743
Format: 0 | 1 (for off | on)
17441744

1745-
hcl= [IA-64] SGI's Hardware Graph compatibility layer
1746-
17471745
hd= [EIDE] (E)IDE hard drive subsystem geometry
17481746
Format: <cyl>,<head>,<sect>
17491747

@@ -2502,7 +2500,7 @@
25022500

25032501
keepinitrd [HW,ARM] See retain_initrd.
25042502

2505-
kernelcore= [KNL,X86,IA-64,PPC,EARLY]
2503+
kernelcore= [KNL,X86,PPC,EARLY]
25062504
Format: nn[KMGTPE] | nn% | "mirror"
25072505
This parameter specifies the amount of memory usable by
25082506
the kernel for non-movable allocations. The requested
@@ -3142,26 +3140,16 @@
31423140
unlikely, in the extreme case this might damage your
31433141
hardware.
31443142

3145-
ltpc= [NET]
3146-
Format: <io>,<irq>,<dma>
3147-
31483143
lsm.debug [SECURITY] Enable LSM initialization debugging output.
31493144

31503145
lsm=lsm1,...,lsmN
31513146
[SECURITY] Choose order of LSM initialization. This
31523147
overrides CONFIG_LSM, and the "security=" parameter.
31533148

3154-
machvec= [IA-64] Force the use of a particular machine-vector
3155-
(machvec) in a generic kernel.
3156-
Example: machvec=hpzx1
3157-
31583149
machtype= [Loongson] Share the same kernel image file between
31593150
different yeeloong laptops.
31603151
Example: machtype=lemote-yeeloong-2f-7inch
31613152

3162-
max_addr=nn[KMG] [KNL,BOOT,IA-64] All physical memory greater
3163-
than or equal to this physical address is ignored.
3164-
31653153
maxcpus= [SMP,EARLY] Maximum number of processors that an SMP kernel
31663154
will bring up during bootup. maxcpus=n : n >= 0 limits
31673155
the kernel to bring up 'n' processors. Surely after
@@ -3399,9 +3387,6 @@
33993387
Enable or disable the microcode minimal revision
34003388
enforcement for the runtime microcode loader.
34013389

3402-
min_addr=nn[KMG] [KNL,BOOT,IA-64] All physical memory below this
3403-
physical address is ignored.
3404-
34053390
mini2440= [ARM,HW,KNL]
34063391
Format:[0..2][b][c][t]
34073392
Default: "0tb"
@@ -3566,7 +3551,7 @@
35663551
mousedev.yres= [MOUSE] Vertical screen resolution, used for devices
35673552
reporting absolute coordinates, such as tablets
35683553

3569-
movablecore= [KNL,X86,IA-64,PPC,EARLY]
3554+
movablecore= [KNL,X86,PPC,EARLY]
35703555
Format: nn[KMGTPE] | nn%
35713556
This parameter is the complement to kernelcore=, it
35723557
specifies the amount of memory used for migratable
@@ -3592,11 +3577,6 @@
35923577
mtdparts= [MTD]
35933578
See drivers/mtd/parsers/cmdlinepart.c
35943579

3595-
mtdset= [ARM]
3596-
ARM/S3C2412 JIVE boot control
3597-
3598-
See arch/arm/mach-s3c/mach-jive.c
3599-
36003580
mtouchusb.raw_coordinates=
36013581
[HW] Make the MicroTouch USB driver use raw coordinates
36023582
('y', default) or cooked coordinates ('n')
@@ -3845,8 +3825,6 @@
38453825

38463826
no_entry_flush [PPC,EARLY] Don't flush the L1-D cache when entering the kernel.
38473827

3848-
noexec [IA-64]
3849-
38503828
noexec32 [X86-64]
38513829
This affects only 32-bit executables.
38523830
noexec32=on: enable non-executable mappings (default)
@@ -3866,13 +3844,6 @@
38663844
register save and restore. The kernel will only save
38673845
legacy floating-point registers on task switch.
38683846

3869-
nohalt [IA-64] Tells the kernel not to use the power saving
3870-
function PAL_HALT_LIGHT when idle. This increases
3871-
power-consumption. On the positive side, it reduces
3872-
interrupt wake-up latency, which may improve performance
3873-
in certain environments such as networked servers or
3874-
real-time systems.
3875-
38763847
no_hash_pointers
38773848
[KNL,EARLY]
38783849
Force pointers printed to the console or buffers to be
@@ -3890,7 +3861,7 @@
38903861

38913862
nohibernate [HIBERNATION] Disable hibernation and resume.
38923863

3893-
nohlt [ARM,ARM64,MICROBLAZE,MIPS,PPC,SH] Forces the kernel to
3864+
nohlt [ARM,ARM64,MICROBLAZE,MIPS,PPC,RISCV,SH] Forces the kernel to
38943865
busy wait in do_idle() and not use the arch_cpu_idle()
38953866
implementation; requires CONFIG_GENERIC_IDLE_POLL_SETUP
38963867
to be effective. This is useful on platforms where the
@@ -3927,8 +3898,6 @@
39273898
remapping.
39283899
[Deprecated - use intremap=off]
39293900

3930-
nointroute [IA-64]
3931-
39323901
noinvpcid [X86,EARLY] Disable the INVPCID cpu feature.
39333902

39343903
noiotrap [SH] Disables trapped I/O port accesses.
@@ -3938,8 +3907,6 @@
39383907

39393908
noisapnp [ISAPNP] Disables ISA PnP code.
39403909

3941-
nojitter [IA-64] Disables jitter checking for ITC timers.
3942-
39433910
nokaslr [KNL,EARLY]
39443911
When CONFIG_RANDOMIZE_BASE is set, this disables
39453912
kernel and module base offset ASLR (Address Space
@@ -3954,8 +3921,6 @@
39543921

39553922
nolapic_timer [X86-32,APIC,EARLY] Do not use the local APIC timer.
39563923

3957-
nomca [IA-64] Disable machine check abort handling
3958-
39593924
nomce [X86-32] Disable Machine Check Exception
39603925

39613926
nomfgpt [X86-32] Disable Multi-Function General Purpose
@@ -4007,8 +3972,6 @@
40073972
noresume [SWSUSP] Disables resume and restores original swap
40083973
space.
40093974

4010-
nosbagart [IA-64]
4011-
40123975
no-scroll [VGA] Disables scrollback.
40133976
This is required for the Braillex ib80-piezo Braille
40143977
reader made by F.H. Papenmeier (Germany).
@@ -4109,19 +4072,6 @@
41094072
parameter, xsave area per process might occupy more
41104073
memory on xsaves enabled systems.
41114074

4112-
nps_mtm_hs_ctr= [KNL,ARC]
4113-
This parameter sets the maximum duration, in
4114-
cycles, each HW thread of the CTOP can run
4115-
without interruptions, before HW switches it.
4116-
The actual maximum duration is 16 times this
4117-
parameter's value.
4118-
Format: integer between 1 and 255
4119-
Default: 255
4120-
4121-
nptcg= [IA-64] Override max number of concurrent global TLB
4122-
purges which is reported from either PAL_VM_SUMMARY or
4123-
SAL PALO.
4124-
41254075
nr_cpus= [SMP,EARLY] Maximum number of processors that an SMP kernel
41264076
could support. nr_cpus=n : n >= 1 limits the kernel to
41274077
support 'n' processors. It could be larger than the
@@ -5774,9 +5724,6 @@
57745724
2 The "airplane mode" button toggles between everything
57755725
blocked and everything unblocked.
57765726

5777-
rhash_entries= [KNL,NET]
5778-
Set number of hash buckets for route cache
5779-
57805727
ring3mwait=disable
57815728
[KNL] Disable ring 3 MONITOR/MWAIT feature on supported
57825729
CPUs.
@@ -6010,9 +5957,6 @@
60105957
apic=verbose is specified.
60115958
Example: apic=debug show_lapic=all
60125959

6013-
simeth= [IA-64]
6014-
simscsi=
6015-
60165960
slab_debug[=options[,slabs][;[options[,slabs]]...] [MM]
60175961
Enabling slab_debug allows one to determine the
60185962
culprit if slab objects become corrupted. Enabling
@@ -6280,11 +6224,6 @@
62806224
Not specifying this option is equivalent to
62816225
spec_store_bypass_disable=auto.
62826226

6283-
spia_io_base= [HW,MTD]
6284-
spia_fio_base=
6285-
spia_pedr=
6286-
spia_peddr=
6287-
62886227
split_lock_detect=
62896228
[X86] Enable split lock detection or bus lock detection
62906229

@@ -6540,7 +6479,7 @@
65406479
This parameter controls use of the Protected
65416480
Execution Facility on pSeries.
65426481

6543-
swiotlb= [ARM,IA-64,PPC,MIPS,X86,EARLY]
6482+
swiotlb= [ARM,PPC,MIPS,X86,S390,EARLY]
65446483
Format: { <int> [,<int>] | force | noforce }
65456484
<int> -- Number of I/O TLB slabs
65466485
<int> -- Second integer after comma. Number of swiotlb
@@ -6621,12 +6560,6 @@
66216560
e.g. base its process migration decisions on it.
66226561
Default is on.
66236562

6624-
topology_updates= [KNL, PPC, NUMA]
6625-
Format: {off}
6626-
Specify if the kernel should ignore (off)
6627-
topology updates sent by the hypervisor to this
6628-
LPAR.
6629-
66306563
torture.disable_onoff_at_boot= [KNL]
66316564
Prevent the CPU-hotplug component of torturing
66326565
until after init has spawned.
@@ -6646,8 +6579,6 @@
66466579
torture.verbose_sleep_duration= [KNL]
66476580
Duration of each verbose-printk() sleep in jiffies.
66486581

6649-
tp720= [HW,PS2]
6650-
66516582
tpm_suspend_pcr=[HW,TPM]
66526583
Format: integer pcr id
66536584
Specify that at suspend time, the tpm driver
@@ -7184,9 +7115,6 @@
71847115
Try vdso32=0 if you encounter an error that says:
71857116
dl_main: Assertion `(void *) ph->p_vaddr == _rtld_local._dl_sysinfo_dso' failed!
71867117

7187-
vector= [IA-64,SMP]
7188-
vector=percpu: enable percpu vector domain
7189-
71907118
video= [FB,EARLY] Frame buffer configuration
71917119
See Documentation/fb/modedb.rst.
71927120

‎Documentation/admin-guide/mm/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ processes address space and many other cool things.
1010

1111
Linux memory management is a complex system with many configurable
1212
settings. Most of these settings are available via ``/proc``
13-
filesystem and can be quired and adjusted using ``sysctl``. These APIs
13+
filesystem and can be queried and adjusted using ``sysctl``. These APIs
1414
are described in Documentation/admin-guide/sysctl/vm.rst and in `man 5 proc`_.
1515

1616
.. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html

‎Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ mistakes occasionally made even by experienced developers.
2323
up in the reference section, then jump back to where you left off.
2424
..
2525
Find the latest rendered version of this text here:
26-
https://docs.kernel.org/admin-guide/verify-bugs-and-bisect-regressions.rst.html
26+
https://docs.kernel.org/admin-guide/verify-bugs-and-bisect-regressions.html
2727
2828
The essence of the process (aka 'TL;DR')
2929
========================================

‎Documentation/arch/x86/cpuinfo.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ conditions are met, the features are enabled by the set_cpu_cap or
112112
setup_force_cpu_cap macros. For example, if bit 5 is set in MSR_IA32_CORE_CAPS,
113113
the feature X86_FEATURE_SPLIT_LOCK_DETECT will be enabled and
114114
"split_lock_detect" will be displayed. The flag "ring3mwait" will be
115-
displayed only when running on INTEL_FAM6_XEON_PHI_[KNL|KNM] processors.
115+
displayed only when running on INTEL_XEON_PHI_[KNL|KNM] processors.
116116

117117
d: Flags can represent purely software features.
118118
------------------------------------------------

‎Documentation/arch/x86/exception-tables.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ vma occurs?
297297
c) execution continues at local label 2 (address of the
298298
instruction immediately after the faulting user access).
299299

300-
The steps 8a to 8c in a certain way emulate the faulting instruction.
300+
The steps a to c above in a certain way emulate the faulting instruction.
301301

302302
That's it, mostly. If you look at our example, you might ask why
303303
we set EAX to -EFAULT in the exception handler code. Well, the

‎Documentation/core-api/genericirq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ implemented (simplified excerpt)::
210210
}
211211
}
212212

213-
noop(struct irq_data *data))
213+
noop(struct irq_data *data)
214214
{
215215
}
216216

‎Documentation/crypto/async-tx-api.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -150,38 +150,38 @@ of an operation.
150150
Perform a xor->copy->xor operation where each operation depends on the
151151
result from the previous operation::
152152

153-
void callback(void *param)
154-
{
155-
struct completion *cmp = param;
153+
#include <linux/async_tx.h>
156154

157-
complete(cmp);
155+
static void callback(void *param)
156+
{
157+
complete(param);
158158
}
159159

160-
void run_xor_copy_xor(struct page **xor_srcs,
161-
int xor_src_cnt,
162-
struct page *xor_dest,
163-
size_t xor_len,
164-
struct page *copy_src,
165-
struct page *copy_dest,
166-
size_t copy_len)
160+
#define NDISKS 2
161+
162+
static void run_xor_copy_xor(struct page **xor_srcs,
163+
struct page *xor_dest,
164+
size_t xor_len,
165+
struct page *copy_src,
166+
struct page *copy_dest,
167+
size_t copy_len)
167168
{
168169
struct dma_async_tx_descriptor *tx;
169-
addr_conv_t addr_conv[xor_src_cnt];
170170
struct async_submit_ctl submit;
171171
addr_conv_t addr_conv[NDISKS];
172172
struct completion cmp;
173173

174174
init_async_submit(&submit, ASYNC_TX_XOR_DROP_DST, NULL, NULL, NULL,
175175
addr_conv);
176-
tx = async_xor(xor_dest, xor_srcs, 0, xor_src_cnt, xor_len, &submit)
176+
tx = async_xor(xor_dest, xor_srcs, 0, NDISKS, xor_len, &submit);
177177

178-
submit->depend_tx = tx;
178+
submit.depend_tx = tx;
179179
tx = async_memcpy(copy_dest, copy_src, 0, 0, copy_len, &submit);
180180

181181
init_completion(&cmp);
182182
init_async_submit(&submit, ASYNC_TX_XOR_DROP_DST | ASYNC_TX_ACK, tx,
183183
callback, &cmp, addr_conv);
184-
tx = async_xor(xor_dest, xor_srcs, 0, xor_src_cnt, xor_len, &submit);
184+
tx = async_xor(xor_dest, xor_srcs, 0, NDISKS, xor_len, &submit);
185185

186186
async_tx_issue_pending_all();
187187

0 commit comments

Comments
 (0)