Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation/ABI: Fix typos

Fix typos in Documentation/ABI. The changes are in descriptions or
comments where they shouldn't affect use of the ABIs.

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230814212822.193684-2-helgaas@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Bjorn Helgaas and committed by
Jonathan Corbet
ebab9426 0ef5de7b

+46 -46
+1 -1
Documentation/ABI/stable/sysfs-block
··· 295 295 capable of executing requests targeting different sector ranges 296 296 in parallel. For instance, single LUN multi-actuator hard-disks 297 297 will have an independent_access_ranges directory if the device 298 - correctly advertizes the sector ranges of its actuators. 298 + correctly advertises the sector ranges of its actuators. 299 299 300 300 The independent_access_ranges directory contains one directory 301 301 per access range, with each range described using the sector
+1 -1
Documentation/ABI/stable/sysfs-class-infiniband
··· 356 356 pkeys/<n>: (RO) Displays the contents of the physical 357 357 key table n = 0..126 358 358 359 - mcgs/: (RO) Muticast group table 359 + mcgs/: (RO) Multicast group table 360 360 361 361 <m>/gid_idx/0: (RO) Display the GID mapping m = 1..2 362 362
+1 -1
Documentation/ABI/stable/sysfs-platform-wmi-bmof
··· 2 2 Date: Jun 2017 3 3 KernelVersion: 4.13 4 4 Description: 5 - Binary MOF metadata used to decribe the details of available ACPI WMI interfaces. 5 + Binary MOF metadata used to describe the details of available ACPI WMI interfaces. 6 6 7 7 See Documentation/wmi/devices/wmi-bmof.rst for details.
+1 -1
Documentation/ABI/testing/debugfs-driver-habanalabs
··· 95 95 Date: Oct 2022 96 96 KernelVersion: 6.2 97 97 Contact: ttayar@habana.ai 98 - Description: The watchdog timeout value in seconds for a device relese upon 98 + Description: The watchdog timeout value in seconds for a device release upon 99 99 certain error cases, after which the device is reset. 100 100 101 101 What: /sys/kernel/debug/habanalabs/hl<n>/dma_size
+1 -1
Documentation/ABI/testing/procfs-diskstats
··· 8 8 9 9 == =================================== 10 10 1 major number 11 - 2 minor mumber 11 + 2 minor number 12 12 3 device name 13 13 4 reads completed successfully 14 14 5 reads merged
+1 -1
Documentation/ABI/testing/sysfs-bus-coreboot
··· 21 21 Date: August 2022 22 22 Contact: Jack Rosenthal <jrosenth@chromium.org> 23 23 Description: 24 - This is the pyhsical memory address that the CBMEM entry's data 24 + This is the physical memory address that the CBMEM entry's data 25 25 begins at, in hexadecimal (e.g., ``0x76ffe000``). 26 26 27 27 What: /sys/bus/coreboot/devices/cbmem-<id>/size
+4 -4
Documentation/ABI/testing/sysfs-bus-coresight-devices-etm3x
··· 31 31 KernelVersion: 3.19 32 32 Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 33 33 Description: (RW) Used in conjunction with @addr_idx. Specifies the range of 34 - addresses to trigger on. Inclusion or exclusion is specificed 34 + addresses to trigger on. Inclusion or exclusion is specified 35 35 in the corresponding access type register. 36 36 37 37 What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_single ··· 304 304 Date: September 2015 305 305 KernelVersion: 4.4 306 306 Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 307 - Description: (RO) Print the content of the ETM Trace Start/Stop Conrol 307 + Description: (RO) Print the content of the ETM Trace Start/Stop Control 308 308 register (0x018). The value is read directly from the HW. 309 309 310 310 What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr1 311 311 Date: September 2015 312 312 KernelVersion: 4.4 313 313 Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 314 - Description: (RO) Print the content of the ETM Enable Conrol #1 314 + Description: (RO) Print the content of the ETM Enable Control #1 315 315 register (0x024). The value is read directly from the HW. 316 316 317 317 What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr2 318 318 Date: September 2015 319 319 KernelVersion: 4.4 320 320 Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 321 - Description: (RO) Print the content of the ETM Enable Conrol #2 321 + Description: (RO) Print the content of the ETM Enable Control #2 322 322 register (0x01c). The value is read directly from the HW.
+1 -1
Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
··· 446 446 KernelVersion: 4.01 447 447 Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 448 448 Description: (Read) Returns the maximum size of the data value, data address, 449 - VMID, context ID and instuction address in the trace unit 449 + VMID, context ID and instruction address in the trace unit 450 450 (0x1E8). The value is taken directly from the HW. 451 451 452 452 What: /sys/bus/coresight/devices/etm<N>/trcidr/trcidr3
+2 -2
Documentation/ABI/testing/sysfs-bus-event_source-devices-events
··· 47 47 If a <term> is specified alone (without an assigned value), it 48 48 is implied that 0x1 is assigned to that <term>. 49 49 50 - Examples (each of these lines would be in a seperate file): 50 + Examples (each of these lines would be in a separate file): 51 51 52 52 event=0x2abc 53 53 event=0x423,inv,cmask=0x3 ··· 83 83 84 84 A string representing a floating point value expressed in 85 85 scientific notation to be multiplied by the event count 86 - recieved from the kernel to match the unit specified in the 86 + received from the kernel to match the unit specified in the 87 87 <event>.unit file. 88 88 89 89 Example:
+2 -2
Documentation/ABI/testing/sysfs-bus-fsi-devices-sbefifo
··· 5 5 Indicates whether or not this SBE device has experienced a 6 6 timeout; i.e. the SBE did not respond within the time allotted 7 7 by the driver. A value of 1 indicates that a timeout has 8 - ocurred and no transfers have completed since the timeout. A 9 - value of 0 indicates that no timeout has ocurred, or if one 8 + occurred and no transfers have completed since the timeout. A 9 + value of 0 indicates that no timeout has occurred, or if one 10 10 has, more recent transfers have completed successful.
+1 -1
Documentation/ABI/testing/sysfs-bus-i2c-devices-fsa9480
··· 8 8 NONE no device 9 9 USB USB device is attached 10 10 UART UART is attached 11 - CHARGER Charger is attaced 11 + CHARGER Charger is attached 12 12 JIG JIG is attached 13 13 ======= ====================== 14 14
+1 -1
Documentation/ABI/testing/sysfs-bus-nfit
··· 121 121 Contact: nvdimm@lists.linux.dev 122 122 Description: 123 123 (RO) ACPI specification 6.2 section 5.2.25.9, defines an 124 - identifier for an NVDIMM, which refelects the id attribute. 124 + identifier for an NVDIMM, which reflects the id attribute. 125 125 126 126 127 127 What: /sys/bus/nd/devices/nmemX/nfit/subsystem_vendor
+1 -1
Documentation/ABI/testing/sysfs-bus-papr-pmem
··· 30 30 Indicating that contents of the 31 31 NVDIMM have been scrubbed. 32 32 * "locked" 33 - Indicating that NVDIMM contents cant 33 + Indicating that NVDIMM contents can't 34 34 be modified until next power cycle. 35 35 36 36 What: /sys/bus/nd/devices/nmemX/papr/perf_stats
+1 -1
Documentation/ABI/testing/sysfs-bus-umc
··· 9 9 Controller (UMC). 10 10 11 11 The umc bus presents each of the individual 12 - capabilties as a device. 12 + capabilities as a device. 13 13 14 14 What: /sys/bus/umc/devices/.../capability_id 15 15 Date: July 2008
+1 -1
Documentation/ABI/testing/sysfs-class
··· 1 1 What: /sys/class/ 2 - Date: Febuary 2006 2 + Date: February 2006 3 3 Contact: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 4 4 Description: 5 5 The /sys/class directory will consist of a group of
+2 -2
Documentation/ABI/testing/sysfs-class-cxl
··· 42 42 Date: September 2014 43 43 Contact: linuxppc-dev@lists.ozlabs.org 44 44 Description: read only 45 - Decimal value of the size of the MMIO space that may be mmaped 45 + Decimal value of the size of the MMIO space that may be mmapped 46 46 by userspace. 47 47 Users: https://github.com/ibm-capi/libcxl 48 48 ··· 155 155 Date: September 2014 156 156 Contact: linuxppc-dev@lists.ozlabs.org 157 157 Description: read only 158 - Decimal value of the size of the MMIO space that may be mmaped 158 + Decimal value of the size of the MMIO space that may be mmapped 159 159 by userspace. This includes all slave contexts space also. 160 160 Users: https://github.com/ibm-capi/libcxl 161 161
+1 -1
Documentation/ABI/testing/sysfs-class-mtd
··· 39 39 Contact: linux-mtd@lists.infradead.org 40 40 Description: 41 41 Major and minor numbers of the character device corresponding 42 - to the read-only variant of thie MTD device (in 42 + to the read-only variant of the MTD device (in 43 43 <major>:<minor> format). In this case <minor> will be odd. 44 44 45 45 What: /sys/class/mtd/mtdX/erasesize
+1 -1
Documentation/ABI/testing/sysfs-class-net
··· 82 82 Contact: netdev@vger.kernel.org 83 83 Description: 84 84 Indicates the current physical link state of the interface. 85 - Posssible values are: 85 + Possible values are: 86 86 87 87 == ===================== 88 88 0 physical link is down
+1 -1
Documentation/ABI/testing/sysfs-class-net-queues
··· 39 39 Description: 40 40 Mask of the CPU(s) currently enabled to participate into the 41 41 Transmit Packet Steering packet processing flow for this 42 - network device transmit queue. Possible vaules depend on the 42 + network device transmit queue. Possible values depend on the 43 43 number of available CPU(s) in the system. 44 44 45 45 What: /sys/class/<iface>/queues/tx-<queue>/xps_rxqs
+1 -1
Documentation/ABI/testing/sysfs-class-power-wilco
··· 22 22 Long Life: 23 23 Customized charge rate for last longer battery life. 24 24 On Wilco device this mode is pre-configured in the factory 25 - through EC's private PID. Swiching to a different mode will 25 + through EC's private PID. Switching to a different mode will 26 26 be denied by Wilco EC when Long Life mode is enabled. 27 27 28 28 What: /sys/class/power_supply/wilco-charger/charge_control_start_threshold
+1 -1
Documentation/ABI/testing/sysfs-class-remoteproc
··· 81 81 collected userspace will directly read from the remote 82 82 processor's device memory. Extra buffer will not be used to 83 83 copy the dump. Also recovery process will not proceed until 84 - all data is read by usersapce. 84 + all data is read by userspace. 85 85 86 86 What: /sys/class/remoteproc/.../recovery 87 87 Date: July 2020
+1 -1
Documentation/ABI/testing/sysfs-class-thermal
··· 4 4 This is given by thermal zone driver as part of registration. 5 5 E.g: "acpitz" indicates it's an ACPI thermal device. 6 6 In order to keep it consistent with hwmon sys attribute; this 7 - shouldbe a short, lowercase string, not containing spaces nor 7 + should be a short, lowercase string, not containing spaces nor 8 8 dashes. 9 9 10 10 RO, Required
+1 -1
Documentation/ABI/testing/sysfs-class-uwb_rc-wusbhc
··· 42 42 KernelVersion: 3.11 43 43 Contact: Thomas Pugliese <thomas.pugliese@gmail.com> 44 44 Description: 45 - The device notification time slot (DNTS) count and inverval in 45 + The device notification time slot (DNTS) count and interval in 46 46 milliseconds that the WUSB host should use. This controls how 47 47 often the devices will have the opportunity to send 48 48 notifications to the host.
+1 -1
Documentation/ABI/testing/sysfs-devices-online
··· 17 17 After a successful execution of the bus type's .offline() 18 18 callback the device cannot be used for any purpose until either 19 19 it is removed (i.e. device_del() is called for it), or its bus 20 - type's .online() is exeucted successfully. 20 + type's .online() is executed successfully.
+1 -1
Documentation/ABI/testing/sysfs-driver-ge-achc
··· 5 5 firmware via the EzPort interface. For this the kernel 6 6 will load "achc.bin" via the firmware API (so usually 7 7 from /lib/firmware). The write will block until the FW 8 - has either been flashed successfully or an error occured. 8 + has either been flashed successfully or an error occurred. 9 9 10 10 What: /sys/bus/spi/<dev>/reset 11 11 Date: Jul 2021
+1 -1
Documentation/ABI/testing/sysfs-driver-tegra-fuse
··· 3 3 Contact: Peter De Schrijver <pdeschrijver@nvidia.com> 4 4 Description: read-only access to the efuses on Tegra20, Tegra30, Tegra114 5 5 and Tegra124 SoC's from NVIDIA. The efuses contain write once 6 - data programmed at the factory. The data is layed out in 32bit 6 + data programmed at the factory. The data is laid out in 32bit 7 7 words in LSB first format. Each bit represents a single value 8 8 as decoded from the fuse registers. Bits order/assignment 9 9 exactly matches the HW registers, including any unused bits.
+1 -1
Documentation/ABI/testing/sysfs-firmware-acpi
··· 84 84 hotplug events associated with the given class of 85 85 devices and will allow those devices to be ejected with 86 86 the help of the _EJ0 control method. Unsetting it 87 - effectively disables hotplug for the correspoinding 87 + effectively disables hotplug for the corresponding 88 88 class of devices. 89 89 ======== ======================================================= 90 90
+2 -2
Documentation/ABI/testing/sysfs-firmware-sgi_uv
··· 102 102 conn_port 103 103 104 104 The conn_hub entry contains a value representing the unique 105 - oridinal value of the hub on the other end of the fabric 105 + ordinal value of the hub on the other end of the fabric 106 106 cable plugged into the port. If the port is disconnected, 107 107 the value returned will be -1. 108 108 109 109 The conn_port entry contains a value representing the unique 110 - oridinal value of the port on the other end of the fabric cable 110 + ordinal value of the port on the other end of the fabric cable 111 111 plugged into the port. If the port is disconnected, the value 112 112 returned will be -1. 113 113
+4 -4
Documentation/ABI/testing/sysfs-fs-f2fs
··· 54 54 0x00 DISABLE disable IPU(=default option in LFS mode) 55 55 0x01 FORCE all the time 56 56 0x02 SSR if SSR mode is activated 57 - 0x04 UTIL if FS utilization is over threashold 57 + 0x04 UTIL if FS utilization is over threshold 58 58 0x08 SSR_UTIL if SSR mode is activated and FS utilization is over 59 - threashold 59 + threshold 60 60 0x10 FSYNC activated in fsync path only for high performance 61 61 flash storages. IPU will be triggered only if the 62 62 # of dirty pages over min_fsync_blocks. ··· 117 117 Contact: "Konstantin Vyshetsky" <vkon@google.com> 118 118 Description: Controls the number of discards a thread will issue at a time. 119 119 Higher number will allow the discard thread to finish its work 120 - faster, at the cost of higher latency for incomming I/O. 120 + faster, at the cost of higher latency for incoming I/O. 121 121 122 122 What: /sys/fs/f2fs/<disk>/min_discard_issue_time 123 123 Date: December 2021 ··· 334 334 state. 2048 trials is set by default. 335 335 336 336 What: /sys/fs/f2fs/<disk>/extension_list 337 - Date: Feburary 2018 337 + Date: February 2018 338 338 Contact: "Chao Yu" <yuchao0@huawei.com> 339 339 Description: Used to control configure extension list: 340 340 - Query: cat /sys/fs/f2fs/<disk>/extension_list
+1 -1
Documentation/ABI/testing/sysfs-kernel-mm-damon
··· 152 152 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/min 153 153 Date: Mar 2022 154 154 Contact: SeongJae Park <sj@kernel.org> 155 - Description: Writing to and reading from this file sets and gets the mimimum 155 + Description: Writing to and reading from this file sets and gets the minimum 156 156 size of the scheme's target regions in bytes. 157 157 158 158 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/max
+2 -2
Documentation/ABI/testing/sysfs-memory-page-offline
··· 10 10 dropping it if possible. The kernel will then be placed 11 11 on the bad page list and never be reused. 12 12 13 - The offlining is done in kernel specific granuality. 13 + The offlining is done in kernel specific granularity. 14 14 Normally it's the base page size of the kernel, but 15 15 this might change. 16 16 ··· 35 35 to access this page assuming it's poisoned by the 36 36 hardware. 37 37 38 - The offlining is done in kernel specific granuality. 38 + The offlining is done in kernel specific granularity. 39 39 Normally it's the base page size of the kernel, but 40 40 this might change. 41 41
+1 -1
Documentation/ABI/testing/sysfs-platform-dell-laptop
··· 15 15 Contact: Gabriele Mazzotta <gabriele.mzt@gmail.com>, 16 16 Pali Rohár <pali@kernel.org> 17 17 Description: 18 - This file allows to specifiy the on/off threshold value, 18 + This file allows to specify the on/off threshold value, 19 19 as reported by the ambient light sensor. 20 20 21 21 What: /sys/class/leds/dell::kbd_backlight/start_triggers
+1 -1
Documentation/ABI/testing/sysfs-platform-dfl-fme
··· 90 90 Contact: Wu Hao <hao.wu@intel.com> 91 91 Description: Read-Write. Read this file to get errors detected on FME. 92 92 Write this file to clear errors logged in fme_errors. Write 93 - fials with -EINVAL if input parsing fails or input error code 93 + fails with -EINVAL if input parsing fails or input error code 94 94 doesn't match. 95 95 96 96 What: /sys/bus/platform/devices/dfl-fme.0/errors/first_error
+1 -1
Documentation/ABI/testing/sysfs-platform-kim
··· 9 9 The device name flows down to architecture specific board 10 10 initialization file from the ATAGS bootloader 11 11 firmware. The name exposed is read from the user-space 12 - dameon and opens the device when install is requested. 12 + daemon and opens the device when install is requested. 13 13 14 14 What: /sys/devices/platform/kim/baud_rate 15 15 Date: January 2010
+1 -1
Documentation/ABI/testing/sysfs-platform-sst-atom
··· 4 4 Contact: "Sebastien Guiriec" <sebastien.guiriec@intel.com> 5 5 Description: 6 6 LPE Firmware version for SST driver on all atom 7 - plaforms (BYT/CHT/Merrifield/BSW). 7 + platforms (BYT/CHT/Merrifield/BSW). 8 8 If the FW has never been loaded it will display:: 9 9 10 10 "FW not yet loaded"