Skip to content

Commit 233a806

Browse files
torvaldstorvalds
committed
Merge tag 'docs-5.14' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "This was a reasonably active cycle for documentation; this includes: - Some kernel-doc cleanups. That script is still regex onslaught from hell, but it has gotten a little better. - Improvements to the checkpatch docs, which are also used by the tool itself. - A major update to the pathname lookup documentation. - Elimination of :doc: markup, since our automarkup magic can create references from filenames without all the extra noise. - The flurry of Chinese translation activity continues. Plus, of course, the usual collection of updates, typo fixes, and warning fixes" * tag 'docs-5.14' of git://git.lwn.net/linux: (115 commits) docs: path-lookup: use bare function() rather than literals docs: path-lookup: update symlink description docs: path-lookup: update get_link() ->follow_link description docs: path-lookup: update WALK_GET, WALK_PUT desc docs: path-lookup: no get_link() docs: path-lookup: update i_op->put_link and cookie description docs: path-lookup: i_op->follow_link replaced with i_op->get_link docs: path-lookup: Add macro name to symlink limit description docs: path-lookup: remove filename_mountpoint docs: path-lookup: update do_last() part docs: path-lookup: update path_mountpoint() part docs: path-lookup: update path_to_nameidata() part docs: path-lookup: update follow_managed() part docs: Makefile: Use CONFIG_SHELL not SHELL docs: Take a little noise out of the build process docs: x86: avoid using ReST :doc:`foo` markup docs: virt: kvm: s390-pv-boot.rst: avoid using ReST :doc:`foo` markup docs: userspace-api: landlock.rst: avoid using ReST :doc:`foo` markup docs: trace: ftrace.rst: avoid using ReST :doc:`foo` markup docs: trace: coresight: coresight.rst: avoid using ReST :doc:`foo` markup ...
2 parents 122fa8c + 98cf495 commit 233a806

147 files changed

Lines changed: 5720 additions & 1076 deletions

File tree

Some content is hidden

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

‎Documentation/ABI/obsolete/sysfs-cpuidle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Description:
66
with the update that cpuidle governor can be changed at runtime in default,
77
both current_governor and current_governor_ro co-exist under
88
/sys/devices/system/cpu/cpuidle/ file, it's duplicate so make
9-
current_governor_ro obselete.
9+
current_governor_ro obsolete.

‎Documentation/ABI/removed/sysfs-kernel-uids‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Contact: Dhaval Giani <dhaval@linux.vnet.ibm.com>
55
Description:
66
The /sys/kernel/uids/<uid>/cpu_shares tunable is used
77
to set the cpu bandwidth a user is allowed. This is a
8-
propotional value. What that means is that if there
8+
proportional value. What that means is that if there
99
are two users logged in, each with an equal number of
1010
shares, then they will get equal CPU bandwidth. Another
1111
example would be, if User A has shares = 1024 and user

‎Documentation/ABI/stable/sysfs-bus-vmbus‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Date: September. 2017
6161
KernelVersion: 4.14
6262
Contact: Stephen Hemminger <sthemmin@microsoft.com>
6363
Description: Directory for per-channel information
64-
NN is the VMBUS relid associtated with the channel.
64+
NN is the VMBUS relid associated with the channel.
6565

6666
What: /sys/bus/vmbus/devices/<UUID>/channels/<N>/cpu
6767
Date: September. 2017

‎Documentation/ABI/stable/sysfs-bus-xen-backend‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Date: April 2011
1919
KernelVersion: 3.0
2020
Contact: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
2121
Description:
22-
The major:minor number (in hexidecimal) of the
22+
The major:minor number (in hexadecimal) of the
2323
physical device providing the storage for this backend
2424
block device.
2525

‎Documentation/ABI/stable/sysfs-devices-system-cpu‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,86 @@ Description: Default value for the Data Stream Control Register (DSCR) on
2323
here).
2424
If set by a process it will be inherited by child processes.
2525
Values: 64 bit unsigned integer (bit field)
26+
27+
What: /sys/devices/system/cpu/cpuX/topology/physical_package_id
28+
Description: physical package id of cpuX. Typically corresponds to a physical
29+
socket number, but the actual value is architecture and platform
30+
dependent.
31+
Values: integer
32+
33+
What: /sys/devices/system/cpu/cpuX/topology/die_id
34+
Description: the CPU die ID of cpuX. Typically it is the hardware platform's
35+
identifier (rather than the kernel's). The actual value is
36+
architecture and platform dependent.
37+
Values: integer
38+
39+
What: /sys/devices/system/cpu/cpuX/topology/core_id
40+
Description: the CPU core ID of cpuX. Typically it is the hardware platform's
41+
identifier (rather than the kernel's). The actual value is
42+
architecture and platform dependent.
43+
Values: integer
44+
45+
What: /sys/devices/system/cpu/cpuX/topology/book_id
46+
Description: the book ID of cpuX. Typically it is the hardware platform's
47+
identifier (rather than the kernel's). The actual value is
48+
architecture and platform dependent. it's only used on s390.
49+
Values: integer
50+
51+
What: /sys/devices/system/cpu/cpuX/topology/drawer_id
52+
Description: the drawer ID of cpuX. Typically it is the hardware platform's
53+
identifier (rather than the kernel's). The actual value is
54+
architecture and platform dependent. it's only used on s390.
55+
Values: integer
56+
57+
What: /sys/devices/system/cpu/cpuX/topology/core_cpus
58+
Description: internal kernel map of CPUs within the same core.
59+
(deprecated name: "thread_siblings")
60+
Values: hexadecimal bitmask.
61+
62+
What: /sys/devices/system/cpu/cpuX/topology/core_cpus_list
63+
Description: human-readable list of CPUs within the same core.
64+
The format is like 0-3, 8-11, 14,17.
65+
(deprecated name: "thread_siblings_list").
66+
Values: decimal list.
67+
68+
What: /sys/devices/system/cpu/cpuX/topology/package_cpus
69+
Description: internal kernel map of the CPUs sharing the same physical_package_id.
70+
(deprecated name: "core_siblings").
71+
Values: hexadecimal bitmask.
72+
73+
What: /sys/devices/system/cpu/cpuX/topology/package_cpus_list
74+
Description: human-readable list of CPUs sharing the same physical_package_id.
75+
The format is like 0-3, 8-11, 14,17.
76+
(deprecated name: "core_siblings_list")
77+
Values: decimal list.
78+
79+
What: /sys/devices/system/cpu/cpuX/topology/die_cpus
80+
Description: internal kernel map of CPUs within the same die.
81+
Values: hexadecimal bitmask.
82+
83+
What: /sys/devices/system/cpu/cpuX/topology/die_cpus_list
84+
Description: human-readable list of CPUs within the same die.
85+
The format is like 0-3, 8-11, 14,17.
86+
Values: decimal list.
87+
88+
What: /sys/devices/system/cpu/cpuX/topology/book_siblings
89+
Description: internal kernel map of cpuX's hardware threads within the same
90+
book_id. it's only used on s390.
91+
Values: hexadecimal bitmask.
92+
93+
What: /sys/devices/system/cpu/cpuX/topology/book_siblings_list
94+
Description: human-readable list of cpuX's hardware threads within the same
95+
book_id.
96+
The format is like 0-3, 8-11, 14,17. it's only used on s390.
97+
Values: decimal list.
98+
99+
What: /sys/devices/system/cpu/cpuX/topology/drawer_siblings
100+
Description: internal kernel map of cpuX's hardware threads within the same
101+
drawer_id. it's only used on s390.
102+
Values: hexadecimal bitmask.
103+
104+
What: /sys/devices/system/cpu/cpuX/topology/drawer_siblings_list
105+
Description: human-readable list of cpuX's hardware threads within the same
106+
drawer_id.
107+
The format is like 0-3, 8-11, 14,17. it's only used on s390.
108+
Values: decimal list.

‎Documentation/ABI/stable/sysfs-driver-dma-idxd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ What: /sys/bus/dsa/devices/wq<m>.<n>/priority
173173
Date: Oct 25, 2019
174174
KernelVersion: 5.6.0
175175
Contact: dmaengine@vger.kernel.org
176-
Description: The priority value of this work queue, it is a vlue relative to
176+
Description: The priority value of this work queue, it is a value relative to
177177
other work queue in the same group to control quality of service
178178
for dispatching work from multiple workqueues in the same group.
179179

‎Documentation/ABI/stable/sysfs-driver-mlxreg-io‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Contact: Vadim Pasternak <vadimpmellanox.com>
137137
Description: These files show the system reset cause, as following:
138138
COMEX thermal shutdown; wathchdog power off or reset was derived
139139
by one of the next components: COMEX, switch board or by Small Form
140-
Factor mezzanine, reset requested from ASIC, reset cuased by BIOS
140+
Factor mezzanine, reset requested from ASIC, reset caused by BIOS
141141
reload. Value 1 in file means this is reset cause, 0 - otherwise.
142142
Only one of the above causes could be 1 at the same time, representing
143143
only last reset cause.
@@ -183,7 +183,7 @@ What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/vpd_wp
183183
Date: January 2020
184184
KernelVersion: 5.6
185185
Contact: Vadim Pasternak <vadimpmellanox.com>
186-
Description: This file allows to overwrite system VPD hardware wrtie
186+
Description: This file allows to overwrite system VPD hardware write
187187
protection when attribute is set 1.
188188

189189
The file is read/write.

‎Documentation/ABI/testing/configfs-iio‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ Date: April 2016
3131
KernelVersion: 4.7
3232
Description:
3333
Dummy IIO devices directory. Creating a directory here will result
34-
in creating a dummy IIO device in the IIO subystem.
34+
in creating a dummy IIO device in the IIO subsystem.

‎Documentation/ABI/testing/configfs-most‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Description:
2020

2121
subbuffer_size
2222
configure the sub-buffer size for this channel
23-
(needed for synchronous and isochrnous data)
23+
(needed for synchronous and isochronous data)
2424

2525

2626
num_buffers
@@ -75,7 +75,7 @@ Description:
7575

7676
subbuffer_size
7777
configure the sub-buffer size for this channel
78-
(needed for synchronous and isochrnous data)
78+
(needed for synchronous and isochronous data)
7979

8080

8181
num_buffers
@@ -130,7 +130,7 @@ Description:
130130

131131
subbuffer_size
132132
configure the sub-buffer size for this channel
133-
(needed for synchronous and isochrnous data)
133+
(needed for synchronous and isochronous data)
134134

135135

136136
num_buffers
@@ -196,7 +196,7 @@ Description:
196196

197197
subbuffer_size
198198
configure the sub-buffer size for this channel
199-
(needed for synchronous and isochrnous data)
199+
(needed for synchronous and isochronous data)
200200

201201

202202
num_buffers

‎Documentation/ABI/testing/configfs-usb-gadget‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Description:
137137
This group contains "OS String" extension handling attributes.
138138

139139
============= ===============================================
140-
use flag turning "OS Desctiptors" support on/off
140+
use flag turning "OS Descriptors" support on/off
141141
b_vendor_code one-byte value used for custom per-device and
142142
per-interface requests
143143
qw_sign an identifier to be reported as "OS String"

0 commit comments

Comments
 (0)