Skip to contentSkip to conversation

docs: gpu: Fix spelling mistakes

PATCH In review Rakuram Eswaran 4 participants 6 messages Aug 20, 2025 – Aug 21, 2025

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: gpu: Fix spelling mistakes

Fixed following typos reported by Codespell

1. filp ==> flip
In Documentation/gpu/drm-mm.rst

2. complection ==> completion
implementions ==> implementations
In Documentation/gpu/todo.rst

3. unpriviledged ==> unprivileged
In Documentation/gpu/drm-uapi.rst

4. propogated ==> propagated
aperatures ==> apertures
In Documentation/gpu/amdgpu/debugfs.rst

5. parition ==> partition
In Documentation/gpu/amdgpu/process-isolation.rst

6. conections ==> connections
In Documentation/gpu/amdgpu/display/programming-model-dcn.rst

---
 Documentation/gpu/amdgpu/debugfs.rst                       | 4 ++--
 Documentation/gpu/amdgpu/display/programming-model-dcn.rst | 2 +-
 Documentation/gpu/amdgpu/process-isolation.rst             | 2 +-
 Documentation/gpu/drm-mm.rst                               | 2 +-
 Documentation/gpu/drm-uapi.rst                             | 2 +-
 Documentation/gpu/todo.rst                                 | 4 ++--
 6 files changed, 8 insertions(+), 8 deletions(-)
Documentation/gpu/amdgpu/debugfs.rst +2 -2
index 5150d0a95658..151d8bfc79e2 100644
@@ -94,7 +94,7 @@ amdgpu_error_<name>
 -------------------
 
 Provides an interface to set an error code on the dma fences associated with
-ring <name>.  The error code specified is propogated to all fences associated
+ring <name>.  The error code specified is propagated to all fences associated
 with the ring.  Use this to inject a fence error into a ring.
 
 amdgpu_pm_info
@@ -165,7 +165,7 @@ GTT memory.
 amdgpu_regs_*
 -------------
 
-Provides direct access to various register aperatures on the GPU.  Used
+Provides direct access to various register apertures on the GPU.  Used
 by tools like UMR to access GPU registers.
 
 amdgpu_regs2
Documentation/gpu/amdgpu/display/programming-model-dcn.rst +1 -1
index c1b48d49fb0b..bc7de97a746f 100644
@@ -100,7 +100,7 @@ represents the connected display.
    For historical reasons, we used the name `dc_link`, which gives the
    wrong impression that this abstraction only deals with physical connections
    that the developer can easily manipulate. However, this also covers
-   conections like eDP or cases where the output is connected to other devices.
+   connections like eDP or cases where the output is connected to other devices.
 
 There are two structs that are not represented in the diagram since they were
 elaborated in the DCN overview page  (check the DCN block diagram :ref:`Display
Documentation/gpu/amdgpu/process-isolation.rst +1 -1
index 6b6d70e357a7..c1297a9e4d09 100644
@@ -26,7 +26,7 @@ Example of enabling enforce isolation on a GPU with multiple partitions:
     $ cat /sys/class/drm/card0/device/enforce_isolation
     1 0 1 0
 
-The output indicates that enforce isolation is enabled on zeroth and second parition and disabled on first and fourth parition.
+The output indicates that enforce isolation is enabled on zeroth and second partition and disabled on first and fourth partition.
 
 For devices with a single partition or those that do not support partitions, there will be only one element:
 
Documentation/gpu/drm-mm.rst +1 -1
index d55751cad67c..3496ef28b15c 100644
@@ -153,7 +153,7 @@ size in bytes.
 GEM uses shmem to allocate anonymous pageable memory.
 drm_gem_object_init() will create an shmfs file of the
 requested size and store it into the struct :c:type:`struct
-drm_gem_object <drm_gem_object>` filp field. The memory is
+drm_gem_object <drm_gem_object>` flip field. The memory is
 used as either main storage for the object when the graphics hardware
 uses system memory directly or as a backing store otherwise.
 
Documentation/gpu/drm-uapi.rst +1 -1
index 843facf01b2d..7435664a1ffe 100644
@@ -535,7 +535,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:
Documentation/gpu/todo.rst +2 -2
index be8637da3fe9..1d064e617699 100644
@@ -319,7 +319,7 @@ everything after it has done the write-protect/mkwrite trickery:
 
       vma->vm_page_prot = pgprot_wrprotect(vma->vm_page_prot);
 
-- Set the mkwrite and fsync callbacks with similar implementions to the core
+- Set the mkwrite and fsync callbacks with similar implementations to the core
   fbdev defio stuff. These should all work on plain ptes, they don't actually
   require a struct page.  uff. These should all work on plain ptes, they don't
   actually require a struct page.
@@ -854,7 +854,7 @@ Querying errors from drm_syncobj
 ================================
 
 The drm_syncobj container can be used by driver independent code to signal
-complection of submission.
+completion of submission.
 
 One minor feature still missing is a generic DRM IOCTL to query the error
 status of binary and timeline drm_syncobj.
Signature · 1 line
2.43.0
reviewer
#1 lore raw

Hi,

Quoted 5 lines · Rakuram Eswaran

Fixed following typos reported by Codespell

1. filp ==> flip
In Documentation/gpu/drm-mm.rst

No, that's a "struct file pointer". filp is correct. See include/drm/drm_gem.h

The others look good.

One more comment below.

Quoted 17 lines
---
 Documentation/gpu/amdgpu/debugfs.rst                       | 4 ++--
 Documentation/gpu/amdgpu/display/programming-model-dcn.rst | 2 +-
 Documentation/gpu/amdgpu/process-isolation.rst             | 2 +-
 Documentation/gpu/drm-mm.rst                               | 2 +-
 Documentation/gpu/drm-uapi.rst                             | 2 +-
 Documentation/gpu/todo.rst                                 | 4 ++--
 6 files changed, 8 insertions(+), 8 deletions(-)
Documentation/gpu/amdgpu/process-isolation.rst +0 -0
index 6b6d70e357a7..c1297a9e4d09 100644

Documentation/gpu/amdgpu/process-isolation.rst Example of enabling enforce isolation on a GPU with multiple partitions: · line 29

Quoted 5 lines
Documentation/gpu/amdgpu/process-isolation.rst +1 -1
@@ -26,7 +26,7 @@ Example of enabling enforce isolation on a GPU with multiple partitions:
     $ cat /sys/class/drm/card0/device/enforce_isolation
     1 0 1 0
 
-The output indicates that enforce isolation is enabled on zeroth and second parition and disabled on first and fourth parition.
+The output indicates that enforce isolation is enabled on zeroth and second partition and disabled on first and fourth partition.

It looks like "fourth" should be "third" here.

Signature · 1 line
~Randy
#2 lore raw

Thanks for catching that. I’ll send a v2 with this fix, including "fourth" -> "third" as suggested.

Thanks,
Rakuram

#3 lore raw
In reply to Rakuram Eswaran

[Public]

Quoted 33 lines

-----Original Message-----
From: Rakuram Eswaran <[email protected]>
Sent: Wednesday, August 20, 2025 2:23 PM
To: [email protected]; Deucher, Alexander <[email protected]>; Koenig, Christian <[email protected]>; [email protected]; [email protected]
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; Wentland, Harry <[email protected]>; [email protected]; dri- [email protected]; [email protected]; linux-kernel- [email protected]; [email protected]; [email protected]
Subject: [PATCH] docs: gpu: Fix spelling mistakes

Fixed following typos reported by Codespell

1. filp ==> flip
In Documentation/gpu/drm-mm.rst

2. complection ==> completion
implementions ==> implementations
In Documentation/gpu/todo.rst

3. unpriviledged ==> unprivileged
In Documentation/gpu/drm-uapi.rst

4. propogated ==> propagated
aperatures ==> apertures
In Documentation/gpu/amdgpu/debugfs.rst

5. parition ==> partition
In Documentation/gpu/amdgpu/process-isolation.rst

Quoted 8 lines

6. conections ==> connections
In Documentation/gpu/amdgpu/display/programming-model-dcn.rst

---
 Documentation/gpu/amdgpu/debugfs.rst                       | 4 ++--
 Documentation/gpu/amdgpu/display/programming-model-dcn.rst | 2 +-
 Documentation/gpu/amdgpu/process-isolation.rst             | 2 +-

Please split this into two patches, one for amdgpu and one for drm.

Thanks,

Alex

Quoted 113 lines
 Documentation/gpu/drm-mm.rst                               | 2 +-
 Documentation/gpu/drm-uapi.rst                             | 2 +-
 Documentation/gpu/todo.rst                                 | 4 ++--
 6 files changed, 8 insertions(+), 8 deletions(-)
Documentation/gpu/amdgpu/debugfs.rst +0 -0
index 5150d0a95658..151d8bfc79e2 100644
@@ -94,7 +94,7 @@ amdgpu_error_<name>
 -------------------
 
 Provides an interface to set an error code on the dma fences associated with -ring

<name>. The error code specified is propogated to all fences associated

Documentation/gpu/amdgpu/debugfs.rst +3 -1
+ring <name>.  The error code specified is propagated to all fences
+associated
 with the ring.  Use this to inject a fence error into a ring.
 
 amdgpu_pm_info
@@ -165,7 +165,7 @@ GTT memory.
 amdgpu_regs_*
 -------------
 
-Provides direct access to various register aperatures on the GPU.  Used
+Provides direct access to various register apertures on the GPU.  Used
 by tools like UMR to access GPU registers.
 
 amdgpu_regs2
Documentation/gpu/amdgpu/display/programming-model-dcn.rst +1 -1
index c1b48d49fb0b..bc7de97a746f 100644
@@ -100,7 +100,7 @@ represents the connected display.
    For historical reasons, we used the name `dc_link`, which gives the
    wrong impression that this abstraction only deals with physical connections
    that the developer can easily manipulate. However, this also covers
-   conections like eDP or cases where the output is connected to other devices.
+   connections like eDP or cases where the output is connected to other devices.
 
 There are two structs that are not represented in the diagram since they were

elaborated in the DCN overview page (check the DCN block diagram :ref:`Display

Documentation/gpu/amdgpu/process-isolation.rst +0 -0
index 6b6d70e357a7..c1297a9e4d09 100644
@@ -26,7 +26,7 @@ Example of enabling enforce isolation on a GPU with multiple

partitions:

     $ cat /sys/class/drm/card0/device/enforce_isolation
     1 0 1 0

-The output indicates that enforce isolation is enabled on zeroth and second parition and disabled on first and fourth parition.
+The output indicates that enforce isolation is enabled on zeroth and second partition and disabled on first and fourth partition.

For devices with a single partition or those that do not support partitions, there will
be only one element:

Documentation/gpu/drm-mm.rst index renamed from Documentation/gpu/drm-mm.rst +0 -0

d55751cad67c..3496ef28b15c 100644

Documentation/gpu/drm-mm.rst +0 -0
@@ -153,7 +153,7 @@ size in bytes.
 GEM uses shmem to allocate anonymous pageable memory.
 drm_gem_object_init() will create an shmfs file of the  requested size and store it

into the struct :c:type:struct -drm_gem_object <drm_gem_object> filp field. The memory is
+drm_gem_object <drm_gem_object>` flip field. The memory is
used as either main storage for the object when the graphics hardware uses
system memory directly or as a backing store otherwise.

Documentation/gpu/drm-uapi.rst index renamed from Documentation/gpu/drm-uapi.rst +0 -0

843facf01b2d..7435664a1ffe 100644

Documentation/gpu/drm-uapi.rst +1 -1
@@ -535,7 +535,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:
Documentation/gpu/todo.rst index renamed from Documentation/gpu/todo.rst +0 -0

be8637da3fe9..1d064e617699 100644

Documentation/gpu/todo.rst +0 -0
@@ -319,7 +319,7 @@ everything after it has done the write-protect/mkwrite

trickery:

       vma->vm_page_prot = pgprot_wrprotect(vma->vm_page_prot);

-- Set the mkwrite and fsync callbacks with similar implementions to the core +- Set the mkwrite and fsync callbacks with similar implementations to

Documentation/gpu/todo.rst +1 -0
+the core
   fbdev defio stuff. These should all work on plain ptes, they don't actually
   require a struct page.  uff. These should all work on plain ptes, they don't
   actually require a struct page.
@@ -854,7 +854,7 @@ Querying errors from drm_syncobj

================================

The drm_syncobj container can be used by driver independent code to signal -
complection of submission.
+completion of submission.

One minor feature still missing is a generic DRM IOCTL to query the error status
of binary and timeline drm_syncobj.
--
2.43.0

#4 lore raw

Got it, thank you for the guidance.

I will split this into a 2-patch series, one targeting amdgpu and one targeting drm, and send v2 accordingly.

Thanks,
Rakuram

maintainer
#5 lore raw
In reply to Rakuram Eswaran
Quoted 4 lines · Rakuram Eswaran

Fixed following typos reported by Codespell

1. filp ==> flip
In Documentation/gpu/drm-mm.rst

That is not a spelling mistake. filp is often used as acronym for "file private" and as far as I can see that is exactly what is meant here.

All others look valid to me.

Regards,
Christian.

Quoted 124 lines

2. complection ==> completion
implementions ==> implementations
In Documentation/gpu/todo.rst

3. unpriviledged ==> unprivileged
In Documentation/gpu/drm-uapi.rst

4. propogated ==> propagated
aperatures ==> apertures
In Documentation/gpu/amdgpu/debugfs.rst

5. parition ==> partition
In Documentation/gpu/amdgpu/process-isolation.rst

6. conections ==> connections
In Documentation/gpu/amdgpu/display/programming-model-dcn.rst

---
 Documentation/gpu/amdgpu/debugfs.rst                       | 4 ++--
 Documentation/gpu/amdgpu/display/programming-model-dcn.rst | 2 +-
 Documentation/gpu/amdgpu/process-isolation.rst             | 2 +-
 Documentation/gpu/drm-mm.rst                               | 2 +-
 Documentation/gpu/drm-uapi.rst                             | 2 +-
 Documentation/gpu/todo.rst                                 | 4 ++--
 6 files changed, 8 insertions(+), 8 deletions(-)
Documentation/gpu/amdgpu/debugfs.rst +2 -2
index 5150d0a95658..151d8bfc79e2 100644
@@ -94,7 +94,7 @@ amdgpu_error_<name>
 -------------------
 
 Provides an interface to set an error code on the dma fences associated with
-ring <name>.  The error code specified is propogated to all fences associated
+ring <name>.  The error code specified is propagated to all fences associated
 with the ring.  Use this to inject a fence error into a ring.
 
 amdgpu_pm_info
@@ -165,7 +165,7 @@ GTT memory.
 amdgpu_regs_*
 -------------
 
-Provides direct access to various register aperatures on the GPU.  Used
+Provides direct access to various register apertures on the GPU.  Used
 by tools like UMR to access GPU registers.
 
 amdgpu_regs2
Documentation/gpu/amdgpu/display/programming-model-dcn.rst +1 -1
index c1b48d49fb0b..bc7de97a746f 100644
@@ -100,7 +100,7 @@ represents the connected display.
    For historical reasons, we used the name `dc_link`, which gives the
    wrong impression that this abstraction only deals with physical connections
    that the developer can easily manipulate. However, this also covers
-   conections like eDP or cases where the output is connected to other devices.
+   connections like eDP or cases where the output is connected to other devices.
 
 There are two structs that are not represented in the diagram since they were
 elaborated in the DCN overview page  (check the DCN block diagram :ref:`Display
Documentation/gpu/amdgpu/process-isolation.rst +1 -1
index 6b6d70e357a7..c1297a9e4d09 100644
@@ -26,7 +26,7 @@ Example of enabling enforce isolation on a GPU with multiple partitions:
     $ cat /sys/class/drm/card0/device/enforce_isolation
     1 0 1 0
 
-The output indicates that enforce isolation is enabled on zeroth and second parition and disabled on first and fourth parition.
+The output indicates that enforce isolation is enabled on zeroth and second partition and disabled on first and fourth partition.
 
 For devices with a single partition or those that do not support partitions, there will be only one element:
 
Documentation/gpu/drm-mm.rst +1 -1
index d55751cad67c..3496ef28b15c 100644
@@ -153,7 +153,7 @@ size in bytes.
 GEM uses shmem to allocate anonymous pageable memory.
 drm_gem_object_init() will create an shmfs file of the
 requested size and store it into the struct :c:type:`struct
-drm_gem_object <drm_gem_object>` filp field. The memory is
+drm_gem_object <drm_gem_object>` flip field. The memory is
 used as either main storage for the object when the graphics hardware
 uses system memory directly or as a backing store otherwise.
 
Documentation/gpu/drm-uapi.rst +1 -1
index 843facf01b2d..7435664a1ffe 100644
@@ -535,7 +535,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:
Documentation/gpu/todo.rst +2 -2
index be8637da3fe9..1d064e617699 100644
@@ -319,7 +319,7 @@ everything after it has done the write-protect/mkwrite trickery:
 
       vma->vm_page_prot = pgprot_wrprotect(vma->vm_page_prot);
 
-- Set the mkwrite and fsync callbacks with similar implementions to the core
+- Set the mkwrite and fsync callbacks with similar implementations to the core
   fbdev defio stuff. These should all work on plain ptes, they don't actually
   require a struct page.  uff. These should all work on plain ptes, they don't
   actually require a struct page.
@@ -854,7 +854,7 @@ Querying errors from drm_syncobj
 ================================
 
 The drm_syncobj container can be used by driver independent code to signal
-complection of submission.
+completion of submission.
 
 One minor feature still missing is a generic DRM IOCTL to query the error
 status of binary and timeline drm_syncobj.