| Message ID | 20240810183238.34481-1-av2082000@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Documentation: Fix spelling mistakes | expand |
On 8/10/24 19:32, Amit Vadhavana wrote: > Corrected spelling mistakes in the documentation to improve readability. > Hi Amit, Since this patch contains changes for multiple files from different subsystems, it should be divided into file-specific changes (so you have one patch per updated file).
Ivan Orlov <ivan.orlov0322@gmail.com> writes: > On 8/10/24 19:32, Amit Vadhavana wrote: >> Corrected spelling mistakes in the documentation to improve readability. >> > > Hi Amit, > > Since this patch contains changes for multiple files from different > subsystems, it should be divided into file-specific changes (so you have > one patch per updated file). Often that is the best thing to do but, honestly, in this case I think I should just take the set through the docs tree. I don't see much point in making things harder. Thanks, jon
Now that I have looked at these, I have a couple of comments... Amit Vadhavana <av2082000@gmail.com> writes: > Corrected spelling mistakes in the documentation to improve readability. Normal form for a changelog is to use the imperative mode; some maintainers are insistent about that. So "Correct spelling ... " > Signed-off-by: Amit Vadhavana <av2082000@gmail.com> > --- > Documentation/arch/arm/stm32/stm32-dma-mdma-chaining.rst | 4 ++-- > Documentation/arch/arm64/cpu-hotplug.rst | 2 +- > Documentation/arch/powerpc/ultravisor.rst | 2 +- > Documentation/arch/riscv/vector.rst | 2 +- > Documentation/arch/sparc/oradax/oracle-dax.rst | 2 +- > Documentation/arch/x86/mds.rst | 2 +- > Documentation/arch/x86/x86_64/fsgs.rst | 4 ++-- > Documentation/process/backporting.rst | 6 +++--- > 8 files changed, 12 insertions(+), 12 deletions(-) [...] > diff --git a/Documentation/arch/riscv/vector.rst b/Documentation/arch/riscv/vector.rst > index 75dd88a62e1d..e4a28def318a 100644 > --- a/Documentation/arch/riscv/vector.rst > +++ b/Documentation/arch/riscv/vector.rst > @@ -15,7 +15,7 @@ status for the use of Vector in userspace. The intended usage guideline for > these interfaces is to give init systems a way to modify the availability of V > for processes running under its domain. Calling these interfaces is not > recommended in libraries routines because libraries should not override policies > -configured from the parant process. Also, users must noted that these interfaces > +configured from the parent process. Also, users must noted that these interfaces As long as you are fixing this line, s/noted/note/ > are not portable to non-Linux, nor non-RISC-V environments, so it is discourage > to use in a portable code. To get the availability of V in an ELF program, > please read :c:macro:`COMPAT_HWCAP_ISA_V` bit of :c:macro:`ELF_HWCAP` in the > diff --git a/Documentation/arch/sparc/oradax/oracle-dax.rst b/Documentation/arch/sparc/oradax/oracle-dax.rst > index d1e14d572918..54ccb35ed51d 100644 > --- a/Documentation/arch/sparc/oradax/oracle-dax.rst > +++ b/Documentation/arch/sparc/oradax/oracle-dax.rst > @@ -197,7 +197,7 @@ Memory Constraints > ================== > > The DAX hardware operates only on physical addresses. Therefore, it is > -not aware of virtual memory mappings and the discontiguities that may > +not aware of virtual memory mappings and the discontinuities that may Whether "discontiguities" is recognized by a spelling checker or not, I expect that is the word that was intended by the author of this document. I would not change it. > exist in the physical memory that a virtual buffer maps to. There is > no I/O TLB or any scatter/gather mechanism. All buffers, whether input > or output, must reside in a physically contiguous region of memory. > diff --git a/Documentation/arch/x86/mds.rst b/Documentation/arch/x86/mds.rst > index c58c72362911..5a2e6c0ef04a 100644 > --- a/Documentation/arch/x86/mds.rst > +++ b/Documentation/arch/x86/mds.rst > @@ -162,7 +162,7 @@ Mitigation points > 3. It would take a large number of these precisely-timed NMIs to mount > an actual attack. There's presumably not enough bandwidth. > 4. The NMI in question occurs after a VERW, i.e. when user state is > - restored and most interesting data is already scrubbed. Whats left > + restored and most interesting data is already scrubbed. What's left > is only the data that NMI touches, and that may or may not be of > any interest. > > diff --git a/Documentation/arch/x86/x86_64/fsgs.rst b/Documentation/arch/x86/x86_64/fsgs.rst > index 50960e09e1f6..d07e445dac5c 100644 > --- a/Documentation/arch/x86/x86_64/fsgs.rst > +++ b/Documentation/arch/x86/x86_64/fsgs.rst > @@ -125,7 +125,7 @@ FSGSBASE instructions enablement > FSGSBASE instructions compiler support > ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > > -GCC version 4.6.4 and newer provide instrinsics for the FSGSBASE > +GCC version 4.6.4 and newer provide intrinsics for the FSGSBASE > instructions. Clang 5 supports them as well. Note that current kernels require rather newer versions of both compilers than this, so this information does not need to be here at all. If you do not want to edit at that level, though, the change is an improvement. Thanks, jon
diff --git a/Documentation/arch/arm/stm32/stm32-dma-mdma-chaining.rst b/Documentation/arch/arm/stm32/stm32-dma-mdma-chaining.rst index 2945e0e33104..301aa30890ae 100644 --- a/Documentation/arch/arm/stm32/stm32-dma-mdma-chaining.rst +++ b/Documentation/arch/arm/stm32/stm32-dma-mdma-chaining.rst @@ -359,7 +359,7 @@ Driver updates for STM32 DMA-MDMA chaining support in foo driver descriptor you want a callback to be called at the end of the transfer (dmaengine_prep_slave_sg()) or the period (dmaengine_prep_dma_cyclic()). Depending on the direction, set the callback on the descriptor that finishes - the overal transfer: + the overall transfer: * DMA_DEV_TO_MEM: set the callback on the "MDMA" descriptor * DMA_MEM_TO_DEV: set the callback on the "DMA" descriptor @@ -371,7 +371,7 @@ Driver updates for STM32 DMA-MDMA chaining support in foo driver As STM32 MDMA channel transfer is triggered by STM32 DMA, you must issue STM32 MDMA channel before STM32 DMA channel. - If any, your callback will be called to warn you about the end of the overal + If any, your callback will be called to warn you about the end of the overall transfer or the period completion. Don't forget to terminate both channels. STM32 DMA channel is configured in diff --git a/Documentation/arch/arm64/cpu-hotplug.rst b/Documentation/arch/arm64/cpu-hotplug.rst index 76ba8d932c72..8fb438bf7781 100644 --- a/Documentation/arch/arm64/cpu-hotplug.rst +++ b/Documentation/arch/arm64/cpu-hotplug.rst @@ -26,7 +26,7 @@ There are no systems that support the physical addition (or removal) of CPUs while the system is running, and ACPI is not able to sufficiently describe them. -e.g. New CPUs come with new caches, but the platform's cache toplogy is +e.g. New CPUs come with new caches, but the platform's cache topology is described in a static table, the PPTT. How caches are shared between CPUs is not discoverable, and must be described by firmware. diff --git a/Documentation/arch/powerpc/ultravisor.rst b/Documentation/arch/powerpc/ultravisor.rst index ba6b1bf1cc44..6d0407b2f5a1 100644 --- a/Documentation/arch/powerpc/ultravisor.rst +++ b/Documentation/arch/powerpc/ultravisor.rst @@ -134,7 +134,7 @@ Hardware * PTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor - Emulation Assitance interrupt. + Emulation Assistance interrupt. * LDBAR (LD Base Address Register) and IMC (In-Memory Collection) non-architected registers. An attempt to write to them will cause a diff --git a/Documentation/arch/riscv/vector.rst b/Documentation/arch/riscv/vector.rst index 75dd88a62e1d..e4a28def318a 100644 --- a/Documentation/arch/riscv/vector.rst +++ b/Documentation/arch/riscv/vector.rst @@ -15,7 +15,7 @@ status for the use of Vector in userspace. The intended usage guideline for these interfaces is to give init systems a way to modify the availability of V for processes running under its domain. Calling these interfaces is not recommended in libraries routines because libraries should not override policies -configured from the parant process. Also, users must noted that these interfaces +configured from the parent process. Also, users must noted that these interfaces are not portable to non-Linux, nor non-RISC-V environments, so it is discourage to use in a portable code. To get the availability of V in an ELF program, please read :c:macro:`COMPAT_HWCAP_ISA_V` bit of :c:macro:`ELF_HWCAP` in the diff --git a/Documentation/arch/sparc/oradax/oracle-dax.rst b/Documentation/arch/sparc/oradax/oracle-dax.rst index d1e14d572918..54ccb35ed51d 100644 --- a/Documentation/arch/sparc/oradax/oracle-dax.rst +++ b/Documentation/arch/sparc/oradax/oracle-dax.rst @@ -197,7 +197,7 @@ Memory Constraints ================== The DAX hardware operates only on physical addresses. Therefore, it is -not aware of virtual memory mappings and the discontiguities that may +not aware of virtual memory mappings and the discontinuities that may exist in the physical memory that a virtual buffer maps to. There is no I/O TLB or any scatter/gather mechanism. All buffers, whether input or output, must reside in a physically contiguous region of memory. diff --git a/Documentation/arch/x86/mds.rst b/Documentation/arch/x86/mds.rst index c58c72362911..5a2e6c0ef04a 100644 --- a/Documentation/arch/x86/mds.rst +++ b/Documentation/arch/x86/mds.rst @@ -162,7 +162,7 @@ Mitigation points 3. It would take a large number of these precisely-timed NMIs to mount an actual attack. There's presumably not enough bandwidth. 4. The NMI in question occurs after a VERW, i.e. when user state is - restored and most interesting data is already scrubbed. Whats left + restored and most interesting data is already scrubbed. What's left is only the data that NMI touches, and that may or may not be of any interest. diff --git a/Documentation/arch/x86/x86_64/fsgs.rst b/Documentation/arch/x86/x86_64/fsgs.rst index 50960e09e1f6..d07e445dac5c 100644 --- a/Documentation/arch/x86/x86_64/fsgs.rst +++ b/Documentation/arch/x86/x86_64/fsgs.rst @@ -125,7 +125,7 @@ FSGSBASE instructions enablement FSGSBASE instructions compiler support ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -GCC version 4.6.4 and newer provide instrinsics for the FSGSBASE +GCC version 4.6.4 and newer provide intrinsics for the FSGSBASE instructions. Clang 5 supports them as well. =================== =========================== @@ -135,7 +135,7 @@ instructions. Clang 5 supports them as well. _writegsbase_u64() Write the GS base register =================== =========================== -To utilize these instrinsics <immintrin.h> must be included in the source +To utilize these intrinsics <immintrin.h> must be included in the source code and the compiler option -mfsgsbase has to be added. Compiler support for FS/GS based addressing diff --git a/Documentation/process/backporting.rst b/Documentation/process/backporting.rst index e1a6ea0a1e8a..a71480fcf3b4 100644 --- a/Documentation/process/backporting.rst +++ b/Documentation/process/backporting.rst @@ -73,7 +73,7 @@ Once you have the patch in git, you can go ahead and cherry-pick it into your source tree. Don't forget to cherry-pick with ``-x`` if you want a written record of where the patch came from! -Note that if you are submiting a patch for stable, the format is +Note that if you are submitting a patch for stable, the format is slightly different; the first line after the subject line needs tobe either:: @@ -147,7 +147,7 @@ divergence. It's important to always identify the commit or commits that caused the conflict, as otherwise you cannot be confident in the correctness of your resolution. As an added bonus, especially if the patch is in an -area you're not that famliar with, the changelogs of these commits will +area you're not that familiar with, the changelogs of these commits will often give you the context to understand the code and potential problems or pitfalls with your conflict resolution. @@ -197,7 +197,7 @@ git blame Another way to find prerequisite commits (albeit only the most recent one for a given conflict) is to run ``git blame``. In this case, you need to run it against the parent commit of the patch you are -cherry-picking and the file where the conflict appared, i.e.:: +cherry-picking and the file where the conflict appeared, i.e.:: git blame <commit>^ -- <path>
Corrected spelling mistakes in the documentation to improve readability. Signed-off-by: Amit Vadhavana <av2082000@gmail.com> --- Documentation/arch/arm/stm32/stm32-dma-mdma-chaining.rst | 4 ++-- Documentation/arch/arm64/cpu-hotplug.rst | 2 +- Documentation/arch/powerpc/ultravisor.rst | 2 +- Documentation/arch/riscv/vector.rst | 2 +- Documentation/arch/sparc/oradax/oracle-dax.rst | 2 +- Documentation/arch/x86/mds.rst | 2 +- Documentation/arch/x86/x86_64/fsgs.rst | 4 ++-- Documentation/process/backporting.rst | 6 +++--- 8 files changed, 12 insertions(+), 12 deletions(-)