Commit f81c2b81 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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
  ...
parents 8541bc1a 323cc36e

Documentation/ABI/README

+2 −1
Original line number Diff line number Diff line 
This directory attempts to document the ABI between the Linux kernel and

This part of the documentation inside Documentation/ABI directory

attempts to document the ABI between the Linux kernel and

userspace, and the relative stability of these interfaces.  Due to the

everchanging nature of Linux, and the differing maturity levels, these

interfaces should be used by userspace programs in different ways.

Documentation/ABI/removed/sysfs-class-rfkill

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ For details to this subsystem look at Documentation/driver-api/rfkill.rst. 


What:		/sys/class/rfkill/rfkill[0-9]+/claim

Date:		09-Jul-2007

KernelVersion	v2.6.22

KernelVersion:	v2.6.22

Contact:	linux-wireless@vger.kernel.org

Description:	This file was deprecated because there no longer was a way to

		claim just control over a single rfkill instance.

Documentation/ABI/stable/sysfs-class-rfkill

+6 −6
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ Description: The rfkill class subsystem folder. 


What:		/sys/class/rfkill/rfkill[0-9]+/name

Date:		09-Jul-2007

KernelVersion	v2.6.22

KernelVersion:	v2.6.22

Contact:	linux-wireless@vger.kernel.org

Description: 	Name assigned by driver to this key (interface or driver name).

Values: 	arbitrary string.
@@ -24,7 +24,7 @@ Values: arbitrary string. 


What: 		/sys/class/rfkill/rfkill[0-9]+/type

Date:		09-Jul-2007

KernelVersion	v2.6.22

KernelVersion:	v2.6.22

Contact:	linux-wireless@vger.kernel.org

Description: 	Driver type string ("wlan", "bluetooth", etc).

Values: 	See include/linux/rfkill.h.
@@ -32,7 +32,7 @@ Values: See include/linux/rfkill.h. 


What:		/sys/class/rfkill/rfkill[0-9]+/persistent

Date:		09-Jul-2007

KernelVersion	v2.6.22

KernelVersion:	v2.6.22

Contact:	linux-wireless@vger.kernel.org

Description: 	Whether the soft blocked state is initialised from non-volatile

		storage at startup.
@@ -44,7 +44,7 @@ Values: A numeric value: 


What:		/sys/class/rfkill/rfkill[0-9]+/state

Date:		09-Jul-2007

KernelVersion	v2.6.22

KernelVersion:	v2.6.22

Contact:	linux-wireless@vger.kernel.org

Description: 	Current state of the transmitter.

		This file was scheduled to be removed in 2014, but due to its
@@ -67,7 +67,7 @@ Values: A numeric value. 


What:		/sys/class/rfkill/rfkill[0-9]+/hard

Date:		12-March-2010

KernelVersion	v2.6.34

KernelVersion:	v2.6.34

Contact:	linux-wireless@vger.kernel.org

Description: 	Current hardblock state. This file is read only.

Values: 	A numeric value.
@@ -81,7 +81,7 @@ Values: A numeric value. 


What:		/sys/class/rfkill/rfkill[0-9]+/soft

Date:		12-March-2010

KernelVersion	v2.6.34

KernelVersion:	v2.6.34

Contact:	linux-wireless@vger.kernel.org

Description:	Current softblock state. This file is read and write.

Values: 	A numeric value.

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

+0 −10
Original line number Diff line number Diff line
@@ -24,12 +24,6 @@ Description: Default value for the Data Stream Control Register (DSCR) on 
		If set by a process it will be inherited by child processes.

Values:		64 bit unsigned integer (bit field)



What:           /sys/devices/system/cpu/cpuX/topology/physical_package_id

Description:    physical package id of cpuX. Typically corresponds to a physical

                socket number, but the actual value is architecture and platform

                dependent.

Values:         integer



What:           /sys/devices/system/cpu/cpuX/topology/die_id

Description:    the CPU die ID of cpuX. Typically it is the hardware platform's

                identifier (rather than the kernel's). The actual value is
@@ -86,10 +80,6 @@ What: /sys/devices/system/cpu/cpuX/topology/die_cpus 
Description:    internal kernel map of CPUs within the same die.

Values:         hexadecimal bitmask.



What:           /sys/devices/system/cpu/cpuX/topology/ppin

Description:    per-socket protected processor inventory number

Values:         hexadecimal.



What:           /sys/devices/system/cpu/cpuX/topology/die_cpus_list

Description:    human-readable list of CPUs within the same die.

                The format is like 0-3, 8-11, 14,17.

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

+2 −2
Original line number Diff line number Diff line
@@ -246,14 +246,14 @@ Description: Controls whether PRS disable is turned on for the workqueue. 
		capability.



What:		/sys/bus/dsa/devices/wq<m>.<n>/occupancy

Date		May 25, 2021

Date:		May 25, 2021

KernelVersion:	5.14.0

Contact:	dmaengine@vger.kernel.org

Description:	Show the current number of entries in this WQ if WQ Occupancy

		Support bit WQ capabilities is 1.



What:		/sys/bus/dsa/devices/wq<m>.<n>/enqcmds_retries

Date		Oct 29, 2021

Date:		Oct 29, 2021

KernelVersion:	5.17.0

Contact:	dmaengine@vger.kernel.org

Description:	Indicate the number of retires for an enqcmds submission on a sharedwq.