Skip to contentSkip to conversation

docs: fix typos in kernel documentation

PATCH Superseded fru1tworld 2 participants 4 messages Apr 14 – Apr 27

Subsystems (5)
lore
Share & tools
lore

fru1tworld

author
#0 lore raw

PATCH 1/1 docs: fix typos in kernel documentation

reinitalizes => reinitializes
unpriviledged => unprivileged
the the => the (duplicated word)
sub-struture => sub-structure

---
 Documentation/block/data-integrity.rst           | 2 +-
 Documentation/core-api/list.rst                  | 2 +-
 Documentation/core-api/real-time/differences.rst | 2 +-
 Documentation/gpu/drm-uapi.rst                   | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)
Documentation/block/data-integrity.rst +1 -1
index 99905e880..b7b10c8ab 100644
@@ -154,7 +154,7 @@ bio_free() will automatically free the bip.
 ----------------
 
 Block devices can set up the integrity information in the integrity
-sub-struture of the queue_limits structure.
+sub-structure of the queue_limits structure.
 
 Layered block devices will need to pick a profile that's appropriate
 for all subdevices.  queue_limits_stack_integrity() can help with that.  DM
Documentation/core-api/list.rst +1 -1
index 241464ca0..4819343a2 100644
@@ -752,7 +752,7 @@ This is because list_splice() did not reinitialize the list_head it took
 entries from, leaving its pointer pointing into what is now a different list.
 
 If we want to avoid this situation, list_splice_init() can be used. It does the
-same thing as list_splice(), except reinitalizes the donor list_head after the
+same thing as list_splice(), except reinitializes the donor list_head after the
 transplant.
 
 Concurrency considerations
Documentation/core-api/real-time/differences.rst +1 -1
index 83ec9aa1c..a129570da 100644
@@ -213,7 +213,7 @@ to suspend until the callback completes, ensuring forward progress without
 risking livelock.
 
 In order to solve the problem at the API level, the sequence locks were extended
-to allow a proper handover between the the spinning reader and the maybe
+to allow a proper handover between the spinning reader and the maybe
 blocked writer.
 
 Sequence locks
Documentation/gpu/drm-uapi.rst +1 -1
index d98428a59..14ecaf98d 100644
@@ -568,7 +568,7 @@ ENOSPC:
 EPERM/EACCES:
         Returned for an operation that is valid, but needs more privileges.
         E.g. root-only or much more common, DRM master-only operations return
-        this when called by unpriviledged clients. There's no clear
+        this when called by unprivileged clients. There's no clear
         difference between EACCES and EPERM.
 
 ENODEV:
Signature · 1 line
2.52.0
maintainer
#1 lore raw

Thank you for working to improve our documentation.

Quoted 4 lines · fru1tworld <[email protected]> writes:

reinitalizes => reinitializes
unpriviledged => unprivileged
the the => the (duplicated word)
sub-struture => sub-structure

These changes generally look OK, but...

Quoted 1 line

We need a proper signoff with your real name, please.

Quoted 4 lines
---
 Documentation/block/data-integrity.rst           | 2 +-
 Documentation/core-api/list.rst                  | 2 +-
 Documentation/core-api/real-time/differences.rst | 2 +-

This one has already been fixed; it's always best to prepare your patches against docs-next or linux-next.

Quoted 2 lines
 Documentation/gpu/drm-uapi.rst                   | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

Thanks,

jon

author
#2 lore raw

PATCH v2 1/1 docs: fix typos in kernel documentation

In reply to fru1tworld

From: Hyeonjin Kim <[email protected]>

reinitalizes => reinitializes
unpriviledged => unprivileged
sub-struture => sub-structure

---
 Documentation/block/data-integrity.rst | 2 +-
 Documentation/core-api/list.rst        | 2 +-
 Documentation/gpu/drm-uapi.rst         | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/block/data-integrity.rst +1 -1
index 99905e880a0e..b7b10c8abbcc 100644
@@ -154,7 +154,7 @@ bio_free() will automatically free the bip.
 ----------------
 
 Block devices can set up the integrity information in the integrity
-sub-struture of the queue_limits structure.
+sub-structure of the queue_limits structure.
 
 Layered block devices will need to pick a profile that's appropriate
 for all subdevices.  queue_limits_stack_integrity() can help with that.  DM
Documentation/core-api/list.rst +1 -1
index 86873ce9adbf..7ff112770c51 100644
@@ -752,7 +752,7 @@ This is because list_splice() did not reinitialize the list_head it took
 entries from, leaving its pointer pointing into what is now a different list.
 
 If we want to avoid this situation, list_splice_init() can be used. It does the
-same thing as list_splice(), except reinitalizes the donor list_head after the
+same thing as list_splice(), except reinitializes the donor list_head after the
 transplant.
 
 Concurrency considerations
Documentation/gpu/drm-uapi.rst +1 -1
index d98428a592f1..14ecaf98df90 100644
@@ -568,7 +568,7 @@ ENOSPC:
 EPERM/EACCES:
         Returned for an operation that is valid, but needs more privileges.
         E.g. root-only or much more common, DRM master-only operations return
-        this when called by unpriviledged clients. There's no clear
+        this when called by unprivileged clients. There's no clear
         difference between EACCES and EPERM.
 
 ENODEV:
Signature · 1 line
2.52.0
maintainer Applied
#3 lore raw
Quoted 6 lines · fru1tworld <[email protected]> writes:

From: Hyeonjin Kim <[email protected]>

reinitalizes => reinitializes
unpriviledged => unprivileged
sub-struture => sub-structure

Quoted 6 lines
---
 Documentation/block/data-integrity.rst | 2 +-
 Documentation/core-api/list.rst        | 2 +-
 Documentation/gpu/drm-uapi.rst         | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

Applied, thanks.

jon