Re: [PATCH] Documentation: fix common spelling mistakes

From: Kees Cook
Date: Tue Apr 26 2016 - 19:49:11 EST

On Tue, Apr 26, 2016 at 4:44 PM, Paul E. McKenney
<paulmck@xxxxxxxxxxxxxxxxxx> wrote:
> On Tue, Apr 26, 2016 at 04:28:27PM -0700, Kees Cook wrote:
>> This fixes several spelling mistakes in the Documentation/ tree, which
>> are caught by checkpatch.pl's spell checking.
>>
>> Signed-off-by: Kees Cook <keescook@xxxxxxxxxxxx>
>
> Both "resizeable" and "resizable" are forms, but I suppose saving
> a few characters is useful.

Yeah, it was debated IIRC when spelling.txt support went in. So, FWIW,
checkpatch will warn about the UK-ism on this.

>
> So, for the RCU pieces:
>
> Reviewed-by: Paul E. McKenney <paulmck@xxxxxxxxxxxxxxxxxx>

Thanks!

-Kees

>
>> ---
>> Documentation/ABI/obsolete/sysfs-driver-hid-roccat-savu | 4 ++--
>> Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7 | 2 +-
>> Documentation/ABI/testing/sysfs-driver-hid-picolcd | 2 +-
>> Documentation/ABI/testing/sysfs-firmware-acpi | 2 +-
>> Documentation/DocBook/media/v4l/controls.xml | 2 +-
>> Documentation/DocBook/media/v4l/dev-raw-vbi.xml | 2 +-
>> Documentation/DocBook/media/v4l/vidioc-g-selection.xml | 2 +-
>> Documentation/RCU/RTFP.txt | 6 +++---
>> Documentation/arm/SA1100/Assabet | 2 +-
>> Documentation/devicetree/bindings/mfd/arizona.txt | 2 +-
>> Documentation/filesystems/cifs/README | 2 +-
>> Documentation/filesystems/pohmelfs/design_notes.txt | 2 +-
>> Documentation/filesystems/qnx6.txt | 2 +-
>> Documentation/firmware_class/README | 2 +-
>> Documentation/hwmon/abituguru | 2 +-
>> Documentation/infiniband/ipoib.txt | 2 +-
>> Documentation/networking/altera_tse.txt | 2 +-
>> Documentation/networking/can.txt | 2 +-
>> Documentation/scsi/bfa.txt | 2 +-
>> Documentation/timers/hrtimers.txt | 2 +-
>> Documentation/video4linux/README.cx88 | 2 +-
>> Documentation/video4linux/bttv/Sound-FAQ | 2 +-
>> Documentation/vm/hugetlbpage.txt | 2 +-
>> 23 files changed, 26 insertions(+), 26 deletions(-)
>>
>> diff --git a/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-savu b/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-savu
>> index f1e02a98bd9d..846c3d5b6d8c 100644
>> --- a/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-savu
>> +++ b/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-savu
>> @@ -3,7 +3,7 @@ Date: Mai 2012
>> Contact: Stefan Achatz <erazor_de@xxxxxxxxxxxxxxxxxxxxx>
>> Description: The mouse can store 5 profiles which can be switched by the
>> press of a button. A profile is split into general settings and
>> - button settings. buttons holds informations about button layout.
>> + button settings. buttons holds information about button layout.
>> When written, this file lets one write the respective profile
>> buttons to the mouse. The data has to be 47 bytes long.
>> The mouse will reject invalid data.
>> @@ -26,7 +26,7 @@ Date: Mai 2012
>> Contact: Stefan Achatz <erazor_de@xxxxxxxxxxxxxxxxxxxxx>
>> Description: The mouse can store 5 profiles which can be switched by the
>> press of a button. A profile is split into general settings and
>> - button settings. profile holds informations like resolution, sensitivity
>> + button settings. profile holds information like resolution, sensitivity
>> and light effects.
>> When written, this file lets one write the respective profile
>> settings back to the mouse. The data has to be 43 bytes long.
>> diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7 b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7
>> index f893337570c1..ec27c6c9e737 100644
>> --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7
>> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7
>> @@ -4,7 +4,7 @@ Contact: Linux on PowerPC Developer List <linuxppc-dev@xxxxxxxxxxxxxxxx>
>> Description:
>> Provides access to the binary "24x7 catalog" provided by the
>> hypervisor on POWER7 and 8 systems. This catalog lists events
>> - avaliable from the powerpc "hv_24x7" pmu. Its format is
>> + available from the powerpc "hv_24x7" pmu. Its format is
>> documented here:
>> https://raw.githubusercontent.com/jmesmon/catalog-24x7/master/hv-24x7-catalog.h
>>
>> diff --git a/Documentation/ABI/testing/sysfs-driver-hid-picolcd b/Documentation/ABI/testing/sysfs-driver-hid-picolcd
>> index 08579e7e1e89..98fd81ad76a1 100644
>> --- a/Documentation/ABI/testing/sysfs-driver-hid-picolcd
>> +++ b/Documentation/ABI/testing/sysfs-driver-hid-picolcd
>> @@ -39,5 +39,5 @@ Description: Make it possible to adjust defio refresh rate.
>> Note: As device can barely do 2 complete refreshes a second
>> it only makes sense to adjust this value if only one or two
>> tiles get changed and it's not appropriate to expect the application
>> - to flush it's tiny changes explicitely at higher than default rate.
>> + to flush its tiny changes explicitly at higher than default rate.
>>
>> diff --git a/Documentation/ABI/testing/sysfs-firmware-acpi b/Documentation/ABI/testing/sysfs-firmware-acpi
>> index b4436cca97a8..c7fc72d4495c 100644
>> --- a/Documentation/ABI/testing/sysfs-firmware-acpi
>> +++ b/Documentation/ABI/testing/sysfs-firmware-acpi
>> @@ -169,7 +169,7 @@ Description:
>> to enable/disable/clear ACPI interrupts in user space, which can be
>> used to debug some ACPI interrupt storm issues.
>>
>> - Note that only writting to VALID GPE/Fixed Event is allowed,
>> + Note that only writing to VALID GPE/Fixed Event is allowed,
>> i.e. user can only change the status of runtime GPE and
>> Fixed Event with event handler installed.
>>
>> diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
>> index 361040e6b0f4..f5f5ce8badac 100644
>> --- a/Documentation/DocBook/media/v4l/controls.xml
>> +++ b/Documentation/DocBook/media/v4l/controls.xml
>> @@ -2841,7 +2841,7 @@ for a GOP and keep it below or equal the set bitrate target. Otherwise the rate
>> overall average bitrate for the stream and keeps it below or equal to the set bitrate. In the first case
>> the average bitrate for the whole stream will be smaller then the set bitrate. This is caused because the
>> average is calculated for smaller number of frames, on the other hand enabling this setting will ensure that
>> -the stream will meet tight bandwidth contraints. Applicable to encoders.
>> +the stream will meet tight bandwidth constraints. Applicable to encoders.
>> </entry>
>> </row>
>> <row><entry></entry></row>
>> diff --git a/Documentation/DocBook/media/v4l/dev-raw-vbi.xml b/Documentation/DocBook/media/v4l/dev-raw-vbi.xml
>> index f4b61b6ce3c2..78599bbd58f7 100644
>> --- a/Documentation/DocBook/media/v4l/dev-raw-vbi.xml
>> +++ b/Documentation/DocBook/media/v4l/dev-raw-vbi.xml
>> @@ -85,7 +85,7 @@ initialize all fields of the &v4l2-vbi-format;
>> results of <constant>VIDIOC_G_FMT</constant>, and call the
>> &VIDIOC-S-FMT; ioctl with a pointer to this structure. Drivers return
>> an &EINVAL; only when the given parameters are ambiguous, otherwise
>> -they modify the parameters according to the hardware capabilites and
>> +they modify the parameters according to the hardware capabilities and
>> return the actual parameters. When the driver allocates resources at
>> this point, it may return an &EBUSY; to indicate the returned
>> parameters are valid but the required resources are currently not
>> diff --git a/Documentation/DocBook/media/v4l/vidioc-g-selection.xml b/Documentation/DocBook/media/v4l/vidioc-g-selection.xml
>> index 7865351688da..a9c0d1dc209a 100644
>> --- a/Documentation/DocBook/media/v4l/vidioc-g-selection.xml
>> +++ b/Documentation/DocBook/media/v4l/vidioc-g-selection.xml
>> @@ -222,7 +222,7 @@ or the <structfield>flags</structfield> argument is not valid.</para>
>> <term><errorcode>ERANGE</errorcode></term>
>> <listitem>
>> <para>It is not possible to adjust &v4l2-rect; <structfield>
>> -r</structfield> rectangle to satisfy all contraints given in the
>> +r</structfield> rectangle to satisfy all constraints given in the
>> <structfield>flags</structfield> argument.</para>
>> </listitem>
>> </varlistentry>
>> diff --git a/Documentation/RCU/RTFP.txt b/Documentation/RCU/RTFP.txt
>> index 370ca006db7a..9bccf16736f7 100644
>> --- a/Documentation/RCU/RTFP.txt
>> +++ b/Documentation/RCU/RTFP.txt
>> @@ -176,13 +176,13 @@ a history of how Linux changed RCU more than RCU changed Linux
>> which Mathieu Desnoyers is now maintaining [MathieuDesnoyers2009URCU]
>> [MathieuDesnoyersPhD]. TINY_RCU [PaulEMcKenney2009BloatWatchRCU] made
>> its appearance, as did expedited RCU [PaulEMcKenney2009expeditedRCU].
>> -The problem of resizeable RCU-protected hash tables may now be on a path
>> +The problem of resizable RCU-protected hash tables may now be on a path
>> to a solution [JoshTriplett2009RPHash]. A few academic researchers are now
>> using RCU to solve their parallel problems [HariKannan2009DynamicAnalysisRCU].
>>
>> 2010 produced a simpler preemptible-RCU implementation
>> based on TREE_RCU [PaulEMcKenney2010SimpleOptRCU], lockdep-RCU
>> -[PaulEMcKenney2010LockdepRCU], another resizeable RCU-protected hash
>> +[PaulEMcKenney2010LockdepRCU], another resizable RCU-protected hash
>> table [HerbertXu2010RCUResizeHash] (this one consuming more memory,
>> but allowing arbitrary changes in hash function, as required for DoS
>> avoidance in the networking code), realization of the 2009 RCU-protected
>> @@ -193,7 +193,7 @@ the RCU API [PaulEMcKenney2010RCUAPI].
>> [LinusTorvalds2011Linux2:6:38:rc1:NPigginVFS], an RCU-protected red-black
>> tree using software transactional memory to protect concurrent updates
>> (strange, but true!) [PhilHoward2011RCUTMRBTree], yet another variant of
>> -RCU-protected resizeable hash tables [Triplett:2011:RPHash], the 3.0 RCU
>> +RCU-protected resizable hash tables [Triplett:2011:RPHash], the 3.0 RCU
>> trainwreck [PaulEMcKenney2011RCU3.0trainwreck], and Neil Brown's "Meet the
>> Lockers" LWN article [NeilBrown2011MeetTheLockers]. Some academic
>> work looked at debugging uses of RCU [Seyster:2011:RFA:2075416.2075425].
>> diff --git a/Documentation/arm/SA1100/Assabet b/Documentation/arm/SA1100/Assabet
>> index 08b885d35674..e08a6739e72c 100644
>> --- a/Documentation/arm/SA1100/Assabet
>> +++ b/Documentation/arm/SA1100/Assabet
>> @@ -214,7 +214,7 @@ RedBoot scripting
>> -----------------
>>
>> All the commands above aren't so useful if they have to be typed in every
>> -time the Assabet is rebooted. Therefore it's possible to automatize the boot
>> +time the Assabet is rebooted. Therefore it's possible to automate the boot
>> process using RedBoot's scripting capability.
>>
>> For example, I use this to boot Linux with both the kernel and the ramdisk
>> diff --git a/Documentation/devicetree/bindings/mfd/arizona.txt b/Documentation/devicetree/bindings/mfd/arizona.txt
>> index 9b30011ecabe..a6e2ea41160c 100644
>> --- a/Documentation/devicetree/bindings/mfd/arizona.txt
>> +++ b/Documentation/devicetree/bindings/mfd/arizona.txt
>> @@ -1,6 +1,6 @@
>> Cirrus Logic/Wolfson Microelectronics Arizona class audio SoCs
>>
>> -These devices are audio SoCs with extensive digital capabilites and a range
>> +These devices are audio SoCs with extensive digital capabilities and a range
>> of analogue I/O.
>>
>> Required properties:
>> diff --git a/Documentation/filesystems/cifs/README b/Documentation/filesystems/cifs/README
>> index 2d5622f60e11..a54788405429 100644
>> --- a/Documentation/filesystems/cifs/README
>> +++ b/Documentation/filesystems/cifs/README
>> @@ -272,7 +272,7 @@ A partial list of the supported mount options follows:
>> same domain (e.g. running winbind or nss_ldap) and
>> the server supports the Unix Extensions then the uid
>> and gid can be retrieved from the server (and uid
>> - and gid would not have to be specifed on the mount.
>> + and gid would not have to be specified on the mount.
>> For servers which do not support the CIFS Unix
>> extensions, the default uid (and gid) returned on lookup
>> of existing files will be the uid (gid) of the person
>> diff --git a/Documentation/filesystems/pohmelfs/design_notes.txt b/Documentation/filesystems/pohmelfs/design_notes.txt
>> index 8aef91335701..106d17fbb05f 100644
>> --- a/Documentation/filesystems/pohmelfs/design_notes.txt
>> +++ b/Documentation/filesystems/pohmelfs/design_notes.txt
>> @@ -29,7 +29,7 @@ Main features of this FS include:
>> * Read request (data read, directory listing, lookup requests) balancing between multiple servers.
>> * Write requests are replicated to multiple servers and completed only when all of them are acked.
>> * Ability to add and/or remove servers from the working set at run-time.
>> - * Strong authentification and possible data encryption in network channel.
>> + * Strong authentication and possible data encryption in network channel.
>> * Extended attributes support.
>>
>> POHMELFS is based on transactions, which are potentially long-standing objects that live
>> diff --git a/Documentation/filesystems/qnx6.txt b/Documentation/filesystems/qnx6.txt
>> index 408679789136..4f3d6a882bdc 100644
>> --- a/Documentation/filesystems/qnx6.txt
>> +++ b/Documentation/filesystems/qnx6.txt
>> @@ -16,7 +16,7 @@ qnx6fs shares many properties with traditional Unix filesystems. It has the
>> concepts of blocks, inodes and directories.
>> On QNX it is possible to create little endian and big endian qnx6 filesystems.
>> This feature makes it possible to create and use a different endianness fs
>> -for the target (QNX is used on quite a range of embedded systems) plattform
>> +for the target (QNX is used on quite a range of embedded systems) platform
>> running on a different endianness.
>> The Linux driver handles endianness transparently. (LE and BE)
>>
>> diff --git a/Documentation/firmware_class/README b/Documentation/firmware_class/README
>> index 71f86859d7d8..434e5db25fc0 100644
>> --- a/Documentation/firmware_class/README
>> +++ b/Documentation/firmware_class/README
>> @@ -20,7 +20,7 @@
>>
>> 1), kernel(driver):
>> - calls request_firmware(&fw_entry, $FIRMWARE, device)
>> - - kernel searchs the fimware image with name $FIRMWARE directly
>> + - kernel searches the fimware image with name $FIRMWARE directly
>> in the below search path of root filesystem:
>> User customized search path by module parameter 'path'[1]
>> "/lib/firmware/updates/" UTS_RELEASE,
>> diff --git a/Documentation/hwmon/abituguru b/Documentation/hwmon/abituguru
>> index 915f32063a26..f1d4fe4c366c 100644
>> --- a/Documentation/hwmon/abituguru
>> +++ b/Documentation/hwmon/abituguru
>> @@ -25,7 +25,7 @@ Supported chips:
>> 1) For revisions 2 and 3 uGuru's the driver can autodetect the
>> sensortype (Volt or Temp) for bank1 sensors, for revision 1 uGuru's
>> this doesnot always work. For these uGuru's the autodection can
>> - be overriden with the bank1_types module param. For all 3 known
>> + be overridden with the bank1_types module param. For all 3 known
>> revison 1 motherboards the correct use of this param is:
>> bank1_types=1,1,0,0,0,0,0,2,0,0,0,0,2,0,0,1
>> You may also need to specify the fan_sensors option for these boards
>> diff --git a/Documentation/infiniband/ipoib.txt b/Documentation/infiniband/ipoib.txt
>> index f2cfe265e836..47c1dd9818f2 100644
>> --- a/Documentation/infiniband/ipoib.txt
>> +++ b/Documentation/infiniband/ipoib.txt
>> @@ -25,7 +25,7 @@ Partitions and P_Keys
>> main interface for a subinterface is in "parent."
>>
>> Child interface create/delete can also be done using IPoIB's
>> - rtnl_link_ops, where childs created using either way behave the same.
>> + rtnl_link_ops, where children created using either way behave the same.
>>
>> Datagram vs Connected modes
>>
>> diff --git a/Documentation/networking/altera_tse.txt b/Documentation/networking/altera_tse.txt
>> index 3f24df8c6e65..cd417d7b5bd4 100644
>> --- a/Documentation/networking/altera_tse.txt
>> +++ b/Documentation/networking/altera_tse.txt
>> @@ -6,7 +6,7 @@ This is the driver for the Altera Triple-Speed Ethernet (TSE) controllers
>> using the SGDMA and MSGDMA soft DMA IP components. The driver uses the
>> platform bus to obtain component resources. The designs used to test this
>> driver were built for a Cyclone(R) V SOC FPGA board, a Cyclone(R) V FPGA board,
>> -and tested with ARM and NIOS processor hosts seperately. The anticipated use
>> +and tested with ARM and NIOS processor hosts separately. The anticipated use
>> cases are simple communications between an embedded system and an external peer
>> for status and simple configuration of the embedded system.
>>
>> diff --git a/Documentation/networking/can.txt b/Documentation/networking/can.txt
>> index 6ab619fcc517..d58ff8467953 100644
>> --- a/Documentation/networking/can.txt
>> +++ b/Documentation/networking/can.txt
>> @@ -1256,7 +1256,7 @@ solution for a couple of reasons:
>> 7. SocketCAN resources
>> -----------------------
>>
>> - The Linux CAN / SocketCAN project ressources (project site / mailing list)
>> + The Linux CAN / SocketCAN project resources (project site / mailing list)
>> are referenced in the MAINTAINERS file in the Linux source tree.
>> Search for CAN NETWORK [LAYERS|DRIVERS].
>>
>> diff --git a/Documentation/scsi/bfa.txt b/Documentation/scsi/bfa.txt
>> index f2d6e9d1791e..3cc4d80d6092 100644
>> --- a/Documentation/scsi/bfa.txt
>> +++ b/Documentation/scsi/bfa.txt
>> @@ -50,7 +50,7 @@ be found at:
>>
>> http://www.brocade.com/services-support/drivers-downloads/adapters/Linux.page
>>
>> -and then click following respective util pacakge link
>> +and then click following respective util package link
>>
>> Version Link
>>
>> diff --git a/Documentation/timers/hrtimers.txt b/Documentation/timers/hrtimers.txt
>> index ce31f65e12e7..bfc3346e2757 100644
>> --- a/Documentation/timers/hrtimers.txt
>> +++ b/Documentation/timers/hrtimers.txt
>> @@ -119,7 +119,7 @@ was not really a win, due to the different data structures. Also, the
>> hrtimer functions now have clearer behavior and clearer names - such as
>> hrtimer_try_to_cancel() and hrtimer_cancel() [which are roughly
>> equivalent to del_timer() and del_timer_sync()] - so there's no direct
>> -1:1 mapping between them on the algorithmical level, and thus no real
>> +1:1 mapping between them on the algorithmic level, and thus no real
>> potential for code sharing either.
>>
>> Basic data types: every time value, absolute or relative, is in a
>> diff --git a/Documentation/video4linux/README.cx88 b/Documentation/video4linux/README.cx88
>> index 35fae23f883b..b09ce36b921e 100644
>> --- a/Documentation/video4linux/README.cx88
>> +++ b/Documentation/video4linux/README.cx88
>> @@ -50,7 +50,7 @@ the driver. What to do then?
>> cx88-cards.c. If that worked, mail me your changes as unified
>> diff ("diff -u").
>> (3) Or you can mail me the config information. I need at least the
>> - following informations to add the card:
>> + following information to add the card:
>>
>> * the PCI Subsystem ID ("0070:3400" from the line above,
>> "lspci -v" output is fine too).
>> diff --git a/Documentation/video4linux/bttv/Sound-FAQ b/Documentation/video4linux/bttv/Sound-FAQ
>> index d3f1d7783d1c..646a47de0016 100644
>> --- a/Documentation/video4linux/bttv/Sound-FAQ
>> +++ b/Documentation/video4linux/bttv/Sound-FAQ
>> @@ -55,7 +55,7 @@ receiver chips. Some boards use the i2c bus instead of the gpio pins
>> to connect the mux chip.
>>
>> As mentioned above, there is a array which holds the required
>> -informations for each known board. You basically have to create a new
>> +information for each known board. You basically have to create a new
>> line for your board. The important fields are these two:
>>
>> struct tvcard
>> diff --git a/Documentation/vm/hugetlbpage.txt b/Documentation/vm/hugetlbpage.txt
>> index 54dd9b9c6c31..b7a3f6d6cfc1 100644
>> --- a/Documentation/vm/hugetlbpage.txt
>> +++ b/Documentation/vm/hugetlbpage.txt
>> @@ -220,7 +220,7 @@ resulting effect on persistent huge page allocation is as follows:
>> node list of "all" with numactl --interleave or --membind [-m] to achieve
>> interleaving over all nodes in the system or cpuset.
>>
>> -4) Any task mempolicy specifed--e.g., using numactl--will be constrained by
>> +4) Any task mempolicy specified--e.g., using numactl--will be constrained by
>> the resource limits of any cpuset in which the task runs. Thus, there will
>> be no way for a task with non-default policy running in a cpuset with a
>> subset of the system nodes to allocate huge pages outside the cpuset
>> --
>> 2.6.3
>>
>>
>> --
>> Kees Cook
>> Chrome OS & Brillo Security
>>
>



--
Kees Cook
Chrome OS & Brillo Security