Documentation/ABI: Fix typos
authorBjorn Helgaas <bhelgaas@google.com>
Mon, 14 Aug 2023 21:28:20 +0000 (16:28 -0500)
committerJonathan Corbet <corbet@lwn.net>
Fri, 18 Aug 2023 17:28:40 +0000 (11:28 -0600)
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>
35 files changed:
Documentation/ABI/stable/sysfs-block
Documentation/ABI/stable/sysfs-class-infiniband
Documentation/ABI/stable/sysfs-platform-wmi-bmof
Documentation/ABI/testing/debugfs-driver-habanalabs
Documentation/ABI/testing/procfs-diskstats
Documentation/ABI/testing/sysfs-bus-coreboot
Documentation/ABI/testing/sysfs-bus-coresight-devices-etm3x
Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
Documentation/ABI/testing/sysfs-bus-event_source-devices-events
Documentation/ABI/testing/sysfs-bus-fsi-devices-sbefifo
Documentation/ABI/testing/sysfs-bus-i2c-devices-fsa9480
Documentation/ABI/testing/sysfs-bus-nfit
Documentation/ABI/testing/sysfs-bus-papr-pmem
Documentation/ABI/testing/sysfs-bus-umc
Documentation/ABI/testing/sysfs-class
Documentation/ABI/testing/sysfs-class-cxl
Documentation/ABI/testing/sysfs-class-mtd
Documentation/ABI/testing/sysfs-class-net
Documentation/ABI/testing/sysfs-class-net-queues
Documentation/ABI/testing/sysfs-class-power-wilco
Documentation/ABI/testing/sysfs-class-remoteproc
Documentation/ABI/testing/sysfs-class-thermal
Documentation/ABI/testing/sysfs-class-uwb_rc-wusbhc
Documentation/ABI/testing/sysfs-devices-online
Documentation/ABI/testing/sysfs-driver-ge-achc
Documentation/ABI/testing/sysfs-driver-tegra-fuse
Documentation/ABI/testing/sysfs-firmware-acpi
Documentation/ABI/testing/sysfs-firmware-sgi_uv
Documentation/ABI/testing/sysfs-fs-f2fs
Documentation/ABI/testing/sysfs-kernel-mm-damon
Documentation/ABI/testing/sysfs-memory-page-offline
Documentation/ABI/testing/sysfs-platform-dell-laptop
Documentation/ABI/testing/sysfs-platform-dfl-fme
Documentation/ABI/testing/sysfs-platform-kim
Documentation/ABI/testing/sysfs-platform-sst-atom

index c57e5b7..1fe9a55 100644 (file)
@@ -295,7 +295,7 @@ Description:
                capable of executing requests targeting different sector ranges
                in parallel. For instance, single LUN multi-actuator hard-disks
                will have an independent_access_ranges directory if the device
-               correctly advertizes the sector ranges of its actuators.
+               correctly advertises the sector ranges of its actuators.
 
                The independent_access_ranges directory contains one directory
                per access range, with each range described using the sector
index ebf08c6..694f23a 100644 (file)
@@ -356,7 +356,7 @@ Description:
                pkeys/<n>:              (RO) Displays the contents of the physical
                                        key table n = 0..126
 
-               mcgs/:                  (RO) Muticast group table
+               mcgs/:                  (RO) Multicast group table
 
                <m>/gid_idx/0:          (RO) Display the GID mapping m = 1..2
 
index a786504..2881244 100644 (file)
@@ -2,6 +2,6 @@ What:           /sys/bus/wmi/devices/05901221-D566-11D1-B2F0-00A0C9062910[-X]/bmof
 Date:          Jun 2017
 KernelVersion: 4.13
 Description:
-               Binary MOF metadata used to decribe the details of available ACPI WMI interfaces.
+               Binary MOF metadata used to describe the details of available ACPI WMI interfaces.
 
                See Documentation/wmi/devices/wmi-bmof.rst for details.
index 85f6d04..df53578 100644 (file)
@@ -95,7 +95,7 @@ What:           /sys/kernel/debug/habanalabs/hl<n>/device_release_watchdog_timeo
 Date:           Oct 2022
 KernelVersion:  6.2
 Contact:        ttayar@habana.ai
-Description:    The watchdog timeout value in seconds for a device relese upon
+Description:    The watchdog timeout value in seconds for a device release upon
                 certain error cases, after which the device is reset.
 
 What:           /sys/kernel/debug/habanalabs/hl<n>/dma_size
index e58d641..6a719cf 100644 (file)
@@ -8,7 +8,7 @@ Description:
 
                ==  ===================================
                 1  major number
-                2  minor mumber
+                2  minor number
                 3  device name
                 4  reads completed successfully
                 5  reads merged
index 9c5acce..8e8d6af 100644 (file)
@@ -21,7 +21,7 @@ What:         /sys/bus/coreboot/devices/cbmem-<id>/address
 Date:          August 2022
 Contact:       Jack Rosenthal <jrosenth@chromium.org>
 Description:
-               This is the pyhsical memory address that the CBMEM entry's data
+               This is the physical memory address that the CBMEM entry's data
                begins at, in hexadecimal (e.g., ``0x76ffe000``).
 
 What:          /sys/bus/coreboot/devices/cbmem-<id>/size
index 234c33f..3acf7fc 100644 (file)
@@ -31,7 +31,7 @@ Date:         November 2014
 KernelVersion: 3.19
 Contact:       Mathieu Poirier <mathieu.poirier@linaro.org>
 Description:   (RW) Used in conjunction with @addr_idx.  Specifies the range of
-               addresses to trigger on.  Inclusion or exclusion is specificed
+               addresses to trigger on.  Inclusion or exclusion is specified
                in the corresponding access type register.
 
 What:          /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_single
@@ -304,19 +304,19 @@ What:             /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtsscr
 Date:          September 2015
 KernelVersion: 4.4
 Contact:       Mathieu Poirier <mathieu.poirier@linaro.org>
-Description:   (RO) Print the content of the ETM Trace Start/Stop Conrol
+Description:   (RO) Print the content of the ETM Trace Start/Stop Control
                register (0x018). The value is read directly from the HW.
 
 What:          /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr1
 Date:          September 2015
 KernelVersion: 4.4
 Contact:       Mathieu Poirier <mathieu.poirier@linaro.org>
-Description:   (RO) Print the content of the ETM Enable Conrol #1
+Description:   (RO) Print the content of the ETM Enable Control #1
                register (0x024). The value is read directly from the HW.
 
 What:          /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr2
 Date:          September 2015
 KernelVersion: 4.4
 Contact:       Mathieu Poirier <mathieu.poirier@linaro.org>
-Description:   (RO) Print the content of the ETM Enable Conrol #2
+Description:   (RO) Print the content of the ETM Enable Control #2
                register (0x01c). The value is read directly from the HW.
index 08b1964..a0425d7 100644 (file)
@@ -446,7 +446,7 @@ Date:               April 2015
 KernelVersion: 4.01
 Contact:       Mathieu Poirier <mathieu.poirier@linaro.org>
 Description:   (Read) Returns the maximum size of the data value, data address,
-               VMID, context ID and instuction address in the trace unit
+               VMID, context ID and instruction address in the trace unit
                (0x1E8).  The value is taken directly from the HW.
 
 What:          /sys/bus/coresight/devices/etm<N>/trcidr/trcidr3
index 505f080..77de58d 100644 (file)
@@ -47,7 +47,7 @@ Description:  Per-pmu performance monitoring events specific to the running syste
                If a <term> is specified alone (without an assigned value), it
                is implied that 0x1 is assigned to that <term>.
 
-               Examples (each of these lines would be in a seperate file):
+               Examples (each of these lines would be in a separate file):
 
                        event=0x2abc
                        event=0x423,inv,cmask=0x3
@@ -83,7 +83,7 @@ Description:  Perf event scaling factors
 
                A string representing a floating point value expressed in
                scientific notation to be multiplied by the event count
-               recieved from the kernel to match the unit specified in the
+               received from the kernel to match the unit specified in the
                <event>.unit file.
 
                Example:
index 531fe9d..1329b0b 100644 (file)
@@ -5,6 +5,6 @@ Description:
                Indicates whether or not this SBE device has experienced a
                timeout; i.e. the SBE did not respond within the time allotted
                by the driver. A value of 1 indicates that a timeout has
-               ocurred and no transfers have completed since the timeout. A
-               value of 0 indicates that no timeout has ocurred, or if one
+               occurred and no transfers have completed since the timeout. A
+               value of 0 indicates that no timeout has occurred, or if one
                has, more recent transfers have completed successful.
index 42dfc93..288bc2f 100644 (file)
@@ -8,7 +8,7 @@ Description:
                NONE     no device
                USB      USB device is attached
                UART     UART is attached
-               CHARGER  Charger is attaced
+               CHARGER  Charger is attached
                JIG      JIG is attached
                =======  ======================
 
index e7282d1..ed483a1 100644 (file)
@@ -121,7 +121,7 @@ KernelVersion:      v4.7
 Contact:       nvdimm@lists.linux.dev
 Description:
                (RO) ACPI specification 6.2 section 5.2.25.9, defines an
-               identifier for an NVDIMM, which refelects the id attribute.
+               identifier for an NVDIMM, which reflects the id attribute.
 
 
 What:          /sys/bus/nd/devices/nmemX/nfit/subsystem_vendor
index 4ac0673..46cfe02 100644 (file)
@@ -30,7 +30,7 @@ Description:
                                  Indicating that contents of the
                                  NVDIMM have been scrubbed.
                * "locked"
-                                 Indicating that NVDIMM contents cant
+                                 Indicating that NVDIMM contents can't
                                  be modified until next power cycle.
 
 What:          /sys/bus/nd/devices/nmemX/papr/perf_stats
index 948fec4..80ef88b 100644 (file)
@@ -9,7 +9,7 @@ Description:
                 Controller (UMC).
 
                 The umc bus presents each of the individual
-                capabilties as a device.
+                capabilities as a device.
 
 What:           /sys/bus/umc/devices/.../capability_id
 Date:           July 2008
index 676530f..906735f 100644 (file)
@@ -1,5 +1,5 @@
 What:          /sys/class/
-Date:          Febuary 2006
+Date:          February 2006
 Contact:       Greg Kroah-Hartman <gregkh@linuxfoundation.org>
 Description:
                The /sys/class directory will consist of a group of
index 594fda2..cfc48a8 100644 (file)
@@ -42,7 +42,7 @@ What:           /sys/class/cxl/<afu>/mmio_size
 Date:           September 2014
 Contact:        linuxppc-dev@lists.ozlabs.org
 Description:    read only
-                Decimal value of the size of the MMIO space that may be mmaped
+                Decimal value of the size of the MMIO space that may be mmapped
                 by userspace.
 Users:         https://github.com/ibm-capi/libcxl
 
@@ -155,7 +155,7 @@ What:           /sys/class/cxl/<afu>m/mmio_size
 Date:           September 2014
 Contact:        linuxppc-dev@lists.ozlabs.org
 Description:    read only
-                Decimal value of the size of the MMIO space that may be mmaped
+                Decimal value of the size of the MMIO space that may be mmapped
                 by userspace. This includes all slave contexts space also.
 Users:         https://github.com/ibm-capi/libcxl
 
index 3bc7c0a..f77fa4f 100644 (file)
@@ -39,7 +39,7 @@ KernelVersion:        2.6.29
 Contact:       linux-mtd@lists.infradead.org
 Description:
                Major and minor numbers of the character device corresponding
-               to the read-only variant of thie MTD device (in
+               to the read-only variant of the MTD device (in
                <major>:<minor> format).  In this case <minor> will be odd.
 
 What:          /sys/class/mtd/mtdX/erasesize
index 1419103..ebf21be 100644 (file)
@@ -82,7 +82,7 @@ KernelVersion:        2.6.12
 Contact:       netdev@vger.kernel.org
 Description:
                Indicates the current physical link state of the interface.
-               Posssible values are:
+               Possible values are:
 
                == =====================
                0  physical link is down
index 978b763..906ff3c 100644 (file)
@@ -39,7 +39,7 @@ Contact:      netdev@vger.kernel.org
 Description:
                Mask of the CPU(s) currently enabled to participate into the
                Transmit Packet Steering packet processing flow for this
-               network device transmit queue. Possible vaules depend on the
+               network device transmit queue. Possible values depend on the
                number of available CPU(s) in the system.
 
 What:          /sys/class/<iface>/queues/tx-<queue>/xps_rxqs
index 82af180..083c464 100644 (file)
@@ -22,7 +22,7 @@ Description:
                Long Life:
                        Customized charge rate for last longer battery life.
                        On Wilco device this mode is pre-configured in the factory
-                       through EC's private PID. Swiching to a different mode will
+                       through EC's private PID. Switching to a different mode will
                        be denied by Wilco EC when Long Life mode is enabled.
 
 What:          /sys/class/power_supply/wilco-charger/charge_control_start_threshold
index 0c9ee55..b2b8e2d 100644 (file)
@@ -81,7 +81,7 @@ Description:  Remote processor coredump configuration
                collected userspace will directly read from the remote
                processor's device memory. Extra buffer will not be used to
                copy the dump. Also recovery process will not proceed until
-               all data is read by usersapce.
+               all data is read by userspace.
 
 What:          /sys/class/remoteproc/.../recovery
 Date:          July 2020
index 8eee379..968d89e 100644 (file)
@@ -4,7 +4,7 @@ Description:
                This is given by thermal zone driver as part of registration.
                E.g: "acpitz" indicates it's an ACPI thermal device.
                In order to keep it consistent with hwmon sys attribute; this
-               shouldbe a short, lowercase string, not containing spaces nor
+               should be a short, lowercase string, not containing spaces nor
                dashes.
 
                RO, Required
index 55eb55c..130ea51 100644 (file)
@@ -42,7 +42,7 @@ Date:           June 2013
 KernelVersion:  3.11
 Contact:        Thomas Pugliese <thomas.pugliese@gmail.com>
 Description:
-                The device notification time slot (DNTS) count and inverval in
+                The device notification time slot (DNTS) count and interval in
                 milliseconds that the WUSB host should use.  This controls how
                 often the devices will have the opportunity to send
                 notifications to the host.
index f990026..c3359fe 100644 (file)
@@ -17,4 +17,4 @@ Description:
                After a successful execution of the bus type's .offline()
                callback the device cannot be used for any purpose until either
                it is removed (i.e. device_del() is called for it), or its bus
-               type's .online() is exeucted successfully.
+               type's .online() is executed successfully.
index a9e7a07..c3e77de 100644 (file)
@@ -5,7 +5,7 @@ Description:    Write 1 to this file to update the ACHC microcontroller
                firmware via the EzPort interface. For this the kernel
                will load "achc.bin" via the firmware API (so usually
                from /lib/firmware). The write will block until the FW
-               has either been flashed successfully or an error occured.
+               has either been flashed successfully or an error occurred.
 
 What:          /sys/bus/spi/<dev>/reset
 Date:          Jul 2021
index 69f5af6..b8936fa 100644 (file)
@@ -3,7 +3,7 @@ Date:           February 2014
 Contact:       Peter De Schrijver <pdeschrijver@nvidia.com>
 Description:   read-only access to the efuses on Tegra20, Tegra30, Tegra114
                and Tegra124 SoC's from NVIDIA. The efuses contain write once
-               data programmed at the factory. The data is layed out in 32bit
+               data programmed at the factory. The data is laid out in 32bit
                words in LSB first format. Each bit represents a single value
                as decoded from the fuse registers. Bits order/assignment
                exactly matches the HW registers, including any unused bits.
index 819939d..5249ad5 100644 (file)
@@ -84,7 +84,7 @@ Description:
                         hotplug events associated with the given class of
                         devices and will allow those devices to be ejected with
                         the help of the _EJ0 control method.  Unsetting it
-                        effectively disables hotplug for the correspoinding
+                        effectively disables hotplug for the corresponding
                         class of devices.
                ======== =======================================================
 
index 12ed843..7fe9244 100644 (file)
@@ -102,12 +102,12 @@ Description:
                        conn_port
 
                The conn_hub entry contains a value representing the unique
-               oridinal value of the hub on the other end of the fabric
+               ordinal value of the hub on the other end of the fabric
                cable plugged into the port. If the port is disconnected,
                the value returned will be -1.
 
                The conn_port entry contains a value representing the unique
-               oridinal value of the port on the other end of the fabric cable
+               ordinal value of the port on the other end of the fabric cable
                plugged into the port. If the port is disconnected, the value
                returned will be -1.
 
index 8140fc9..ad3d76d 100644 (file)
@@ -54,9 +54,9 @@ Description:  Controls the in-place-update policy.
                0x00  DISABLE         disable IPU(=default option in LFS mode)
                0x01  FORCE           all the time
                0x02  SSR             if SSR mode is activated
-               0x04  UTIL            if FS utilization is over threashold
+               0x04  UTIL            if FS utilization is over threshold
                0x08  SSR_UTIL        if SSR mode is activated and FS utilization is over
-                                     threashold
+                                     threshold
                0x10  FSYNC           activated in fsync path only for high performance
                                      flash storages. IPU will be triggered only if the
                                      # of dirty pages over min_fsync_blocks.
@@ -117,7 +117,7 @@ Date:               December 2021
 Contact:       "Konstantin Vyshetsky" <vkon@google.com>
 Description:   Controls the number of discards a thread will issue at a time.
                Higher number will allow the discard thread to finish its work
-               faster, at the cost of higher latency for incomming I/O.
+               faster, at the cost of higher latency for incoming I/O.
 
 What:          /sys/fs/f2fs/<disk>/min_discard_issue_time
 Date:          December 2021
@@ -334,7 +334,7 @@ Description:        This indicates how many GC can be failed for the pinned
                state. 2048 trials is set by default.
 
 What:          /sys/fs/f2fs/<disk>/extension_list
-Date:          Feburary 2018
+Date:          February 2018
 Contact:       "Chao Yu" <yuchao0@huawei.com>
 Description:   Used to control configure extension list:
                - Query: cat /sys/fs/f2fs/<disk>/extension_list
index 2744f21..464ac5c 100644 (file)
@@ -152,7 +152,7 @@ Description:        Writing to and reading from this file sets and gets the action
 What:          /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/min
 Date:          Mar 2022
 Contact:       SeongJae Park <sj@kernel.org>
-Description:   Writing to and reading from this file sets and gets the mimimum
+Description:   Writing to and reading from this file sets and gets the minimum
                size of the scheme's target regions in bytes.
 
 What:          /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/max
index e14703f..00f4e35 100644 (file)
@@ -10,7 +10,7 @@ Description:
                dropping it if possible. The kernel will then be placed
                on the bad page list and never be reused.
 
-               The offlining is done in kernel specific granuality.
+               The offlining is done in kernel specific granularity.
                Normally it's the base page size of the kernel, but
                this might change.
 
@@ -35,7 +35,7 @@ Description:
                to access this page assuming it's poisoned by the
                hardware.
 
-               The offlining is done in kernel specific granuality.
+               The offlining is done in kernel specific granularity.
                Normally it's the base page size of the kernel, but
                this might change.
 
index 82bcfe9..7015296 100644 (file)
@@ -15,7 +15,7 @@ KernelVersion:        3.19
 Contact:       Gabriele Mazzotta <gabriele.mzt@gmail.com>,
                Pali Rohár <pali@kernel.org>
 Description:
-               This file allows to specifiy the on/off threshold value,
+               This file allows to specify the on/off threshold value,
                as reported by the ambient light sensor.
 
 What:          /sys/class/leds/dell::kbd_backlight/start_triggers
index d6ab34e..2d5b78d 100644 (file)
@@ -90,7 +90,7 @@ KernelVersion:  5.4
 Contact:       Wu Hao <hao.wu@intel.com>
 Description:   Read-Write. Read this file to get errors detected on FME.
                Write this file to clear errors logged in fme_errors. Write
-               fials with -EINVAL if input parsing fails or input error code
+               fails with -EINVAL if input parsing fails or input error code
                doesn't match.
 
 What:          /sys/bus/platform/devices/dfl-fme.0/errors/first_error
index 6a52d6d..0a38caa 100644 (file)
@@ -9,7 +9,7 @@ Description:
                The device name flows down to architecture specific board
                initialization file from the ATAGS bootloader
                firmware. The name exposed is read from the user-space
-               dameon and opens the device when install is requested.
+               daemon and opens the device when install is requested.
 
 What:          /sys/devices/platform/kim/baud_rate
 Date:          January 2010
index 0154b0f..4bb2e61 100644 (file)
@@ -4,7 +4,7 @@ KernelVersion:  4.10
 Contact:       "Sebastien Guiriec" <sebastien.guiriec@intel.com>
 Description:
                LPE Firmware version for SST driver on all atom
-               plaforms (BYT/CHT/Merrifield/BSW).
+               platforms (BYT/CHT/Merrifield/BSW).
                If the FW has never been loaded it will display::
 
                        "FW not yet loaded"