Skip to content

Commit f81c2b8

Browse files
committed
Merge tag 'docs-6.15' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "It has been a reasonably busy cycle for docs... - Significant changes throughout the tree to bring Python code up to current standards and raise the minimum Python required to 3.9 Much of this is preparatory to replacing the ancient Perl scripts/kernel-doc horror with a slightly less horrifying Python implementation, expected for 6.16 - Update the minimum Sphinx required to 3.4.3, allowing us to remove a bunch of older compatibility code - Rework and improve the generation of the ABI documentation (All of the above done by Mauro) - Lots of translation updates. Alex Shi and Yanteng Si are taking on responsibility for the Chinese translations going forward; that work will still get to you via docs-next - Try to standardize the format for indicating a developer's affiliation in commit tags - Clarify the TAB's role in CoC enforcement actions - Try to spell out the rules for when a commit tag can name another developer without their explicit permission Plus lots of other typo fixes and updates" * tag 'docs-6.15' of git://git.lwn.net/linux: (98 commits) docs/zh_CN: fix spelling mistake docs/Chinese: change the disclaimer words docs/zh_CN: Add snp-tdx-threat-model index Chinese translation docs: driver-api: firmware: clarify userspace requirements docs: clarify rules wrt tagging other people docs: Remove outdated highuid.rst documentation Documentation: dma-buf: heaps: Add heap name definitions docs/.../submit-checklist: Use Documentation/admin-guide/abi.rst for cross-ref of README docs: Correct installation instruction Documentation: kcsan: fix "Plain Accesses and Data Races" URL in kcsan.rst Documentation/CoC: Spell out the TAB role in enforcement decisions Documentation: ocxl.rst: Update consortium site scripts: get_feat.pl: substitute s390x with s390 scripts/kernel-doc: drop dead code for Wcontents_before_sections scripts/kernel-doc: don't add not needed new lines docs: driver-api/infiniband.rst: fix Kerneldoc markup drivers: firewire: firewire-cdev.h: fix identation on a kernel-doc markup drivers: media: intel-ipu3.h: fix identation on a kernel-doc markup include/asm-generic/io.h: fix kerneldoc markup Docs/arch/arm64: Fix spelling in amu.rst ...
2 parents 8541bc1 + 323cc36 commit f81c2b8

File tree

125 files changed

+3808
-1925
lines changed

Some content is hidden

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

125 files changed

+3808
-1925
lines changed

Documentation/ABI/README

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
This directory attempts to document the ABI between the Linux kernel and
1+
This part of the documentation inside Documentation/ABI directory
2+
attempts to document the ABI between the Linux kernel and
23
userspace, and the relative stability of these interfaces. Due to the
34
everchanging nature of Linux, and the differing maturity levels, these
45
interfaces should be used by userspace programs in different ways.

Documentation/ABI/removed/sysfs-class-rfkill

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ For details to this subsystem look at Documentation/driver-api/rfkill.rst.
44

55
What: /sys/class/rfkill/rfkill[0-9]+/claim
66
Date: 09-Jul-2007
7-
KernelVersion v2.6.22
7+
KernelVersion: v2.6.22
88
Contact: linux-wireless@vger.kernel.org
99
Description: This file was deprecated because there no longer was a way to
1010
claim just control over a single rfkill instance.

Documentation/ABI/stable/sysfs-class-rfkill

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@ Description: The rfkill class subsystem folder.
1616

1717
What: /sys/class/rfkill/rfkill[0-9]+/name
1818
Date: 09-Jul-2007
19-
KernelVersion v2.6.22
19+
KernelVersion: v2.6.22
2020
Contact: linux-wireless@vger.kernel.org
2121
Description: Name assigned by driver to this key (interface or driver name).
2222
Values: arbitrary string.
2323

2424

2525
What: /sys/class/rfkill/rfkill[0-9]+/type
2626
Date: 09-Jul-2007
27-
KernelVersion v2.6.22
27+
KernelVersion: v2.6.22
2828
Contact: linux-wireless@vger.kernel.org
2929
Description: Driver type string ("wlan", "bluetooth", etc).
3030
Values: See include/linux/rfkill.h.
3131

3232

3333
What: /sys/class/rfkill/rfkill[0-9]+/persistent
3434
Date: 09-Jul-2007
35-
KernelVersion v2.6.22
35+
KernelVersion: v2.6.22
3636
Contact: linux-wireless@vger.kernel.org
3737
Description: Whether the soft blocked state is initialised from non-volatile
3838
storage at startup.
@@ -44,7 +44,7 @@ Values: A numeric value:
4444

4545
What: /sys/class/rfkill/rfkill[0-9]+/state
4646
Date: 09-Jul-2007
47-
KernelVersion v2.6.22
47+
KernelVersion: v2.6.22
4848
Contact: linux-wireless@vger.kernel.org
4949
Description: Current state of the transmitter.
5050
This file was scheduled to be removed in 2014, but due to its
@@ -67,7 +67,7 @@ Values: A numeric value.
6767

6868
What: /sys/class/rfkill/rfkill[0-9]+/hard
6969
Date: 12-March-2010
70-
KernelVersion v2.6.34
70+
KernelVersion: v2.6.34
7171
Contact: linux-wireless@vger.kernel.org
7272
Description: Current hardblock state. This file is read only.
7373
Values: A numeric value.
@@ -81,7 +81,7 @@ Values: A numeric value.
8181

8282
What: /sys/class/rfkill/rfkill[0-9]+/soft
8383
Date: 12-March-2010
84-
KernelVersion v2.6.34
84+
KernelVersion: v2.6.34
8585
Contact: linux-wireless@vger.kernel.org
8686
Description: Current softblock state. This file is read and write.
8787
Values: A numeric value.

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@ Description: Default value for the Data Stream Control Register (DSCR) on
2424
If set by a process it will be inherited by child processes.
2525
Values: 64 bit unsigned integer (bit field)
2626

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-
3327
What: /sys/devices/system/cpu/cpuX/topology/die_id
3428
Description: the CPU die ID of cpuX. Typically it is the hardware platform's
3529
identifier (rather than the kernel's). The actual value is
@@ -86,10 +80,6 @@ What: /sys/devices/system/cpu/cpuX/topology/die_cpus
8680
Description: internal kernel map of CPUs within the same die.
8781
Values: hexadecimal bitmask.
8882

89-
What: /sys/devices/system/cpu/cpuX/topology/ppin
90-
Description: per-socket protected processor inventory number
91-
Values: hexadecimal.
92-
9383
What: /sys/devices/system/cpu/cpuX/topology/die_cpus_list
9484
Description: human-readable list of CPUs within the same die.
9585
The format is like 0-3, 8-11, 14,17.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,14 +246,14 @@ Description: Controls whether PRS disable is turned on for the workqueue.
246246
capability.
247247

248248
What: /sys/bus/dsa/devices/wq<m>.<n>/occupancy
249-
Date May 25, 2021
249+
Date: May 25, 2021
250250
KernelVersion: 5.14.0
251251
Contact: dmaengine@vger.kernel.org
252252
Description: Show the current number of entries in this WQ if WQ Occupancy
253253
Support bit WQ capabilities is 1.
254254

255255
What: /sys/bus/dsa/devices/wq<m>.<n>/enqcmds_retries
256-
Date Oct 29, 2021
256+
Date: Oct 29, 2021
257257
KernelVersion: 5.17.0
258258
Contact: dmaengine@vger.kernel.org
259259
Description: Indicate the number of retires for an enqcmds submission on a sharedwq.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Description:
4747
midi1_first_group The first UMP Group number for MIDI 1.0 (0-15)
4848
midi1_num_groups The number of groups for MIDI 1.0 (0-16)
4949
ui_hint 0: unknown, 1: receiver, 2: sender, 3: both
50-
midi_ci_verison Supported MIDI-CI version number (8 bit)
50+
midi_ci_version Supported MIDI-CI version number (8 bit)
5151
is_midi1 Legacy MIDI 1.0 device (0, 1 or 2)
5252
sysex8_streams Max number of SysEx8 streams (8 bit)
5353
active Active FB flag (0 or 1)

0 commit comments

Comments
 (0)