Skip to contentSkip to conversation

Documentation: Fix typos in filesystems

PATCH In review Methari Hari Krishna 3 participants 5 messages Aug 30, 2025

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

PATCH 1/1 Documentation: Fix typos in filesystems

Fixed minor spelling and grammar mistakes in:
- bcachefs/future/idle_work.rst
- hpfs.rst
- smb/cifsroot.rst
- vfat.rst

---
 Documentation/filesystems/bcachefs/future/idle_work.rst | 6 +++---
 Documentation/filesystems/hpfs.rst                      | 2 +-
 Documentation/filesystems/smb/cifsroot.rst              | 2 +-
 Documentation/filesystems/vfat.rst                      | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)
Documentation/filesystems/bcachefs/future/idle_work.rst +3 -3
index 59a332509dcd..f1202113dde0 100644
@@ -11,10 +11,10 @@ idle" so the system can go to sleep. We don't want to be dribbling out
 background work while the system should be idle.
 
 The complicating factor is that there are a number of background tasks, which
-form a heirarchy (or a digraph, depending on how you divide it up) - one
+form a hierarchy (or a digraph, depending on how you divide it up) - one
 background task may generate work for another.
 
-Thus proper idle detection needs to model this heirarchy.
+Thus proper idle detection needs to model this hierarchy.
 
 - Foreground writes
 - Page cache writeback
@@ -51,7 +51,7 @@ IDLE REGIME
 When the system becomes idle, we should start flushing our pending work
 quicker so the system can go to sleep.
 
-Note that the definition of "idle" depends on where in the heirarchy a task
+Note that the definition of "idle" depends on where in the hierarchy a task
 is - a task should start flushing work more quickly when the task above it has
 stopped generating new work.
 
Documentation/filesystems/hpfs.rst +1 -1
index 7e0dd2f4373e..e2a0872a577d 100644
@@ -65,7 +65,7 @@ are case sensitive, so for example when you create a file FOO, you can use
 'cat FOO', 'cat Foo', 'cat foo' or 'cat F*' but not 'cat f*'. Note, that you
 also won't be able to compile linux kernel (and maybe other things) on HPFS
 because kernel creates different files with names like bootsect.S and
-bootsect.s. When searching for file thats name has characters >= 128, codepages
+bootsect.s. When searching for file that's name has characters >= 128, codepages
 are used - see below.
 OS/2 ignores dots and spaces at the end of file name, so this driver does as
 well. If you create 'a. ...', the file 'a' will be created, but you can still
Documentation/filesystems/smb/cifsroot.rst +1 -1
index bf2d9db3acb9..8e8c3fb8739a 100644
@@ -82,7 +82,7 @@ Export root file system as a Samba share in smb.conf file::
 	    guest ok = yes
 	    force user = root
 	    force group = root
-	    browseable = yes
+	    browsable = yes
 	    writeable = yes
 	    admin users = root
 	    public = yes
Documentation/filesystems/vfat.rst +1 -1
index b289c4449cd0..f408699ce50f 100644
@@ -361,7 +361,7 @@ the following:
 
                 <proceeding files...>
                 <slot #3, id = 0x43, characters = "h is long">
-                <slot #2, id = 0x02, characters = "xtension whic">
+                <slot #2, id = 0x02, characters = "xtension which">
                 <slot #1, id = 0x01, characters = "My Big File.E">
                 <directory entry, name = "MYBIGFIL.EXT">
 
Signature · 1 line
2.51.0
reviewer
#1 lore raw

Hi,

Quoted 19 lines · Methari Hari Krishna

Fixed minor spelling and grammar mistakes in:
- bcachefs/future/idle_work.rst
- hpfs.rst
- smb/cifsroot.rst
- vfat.rst

---
 Documentation/filesystems/bcachefs/future/idle_work.rst | 6 +++---
 Documentation/filesystems/hpfs.rst                      | 2 +-
 Documentation/filesystems/smb/cifsroot.rst              | 2 +-
 Documentation/filesystems/vfat.rst                      | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)
Documentation/filesystems/bcachefs/future/idle_work.rst +0 -0
index 59a332509dcd..f1202113dde0 100644

Documentation/filesystems/bcachefs/future/idle_work.rst idle" so the system can go to sleep. We don't want to be dribbling out · line 17

Quoted 9 lines
Documentation/filesystems/bcachefs/future/idle_work.rst +2 -2
@@ -11,10 +11,10 @@ idle" so the system can go to sleep. We don't want to be dribbling out
 background work while the system should be idle.
 
 The complicating factor is that there are a number of background tasks, which
-form a heirarchy (or a digraph, depending on how you divide it up) - one
+form a hierarchy (or a digraph, depending on how you divide it up) - one
 background task may generate work for another.
 
-Thus proper idle detection needs to model this heirarchy.
+Thus proper idle detection needs to model this hierarchy.

There is already a patch for this but I can't tell that it has been merged yet.

https://lore.kernel.org/all/aFB1tGW3Iwf0isZ3@itsmeut/

Quoted 17 lines
Documentation/filesystems/bcachefs/future/idle_work.rst +1 -1
 - Foreground writes
 - Page cache writeback
@@ -51,7 +51,7 @@ IDLE REGIME
 When the system becomes idle, we should start flushing our pending work
 quicker so the system can go to sleep.
 
-Note that the definition of "idle" depends on where in the heirarchy a task
+Note that the definition of "idle" depends on where in the hierarchy a task
 is - a task should start flushing work more quickly when the task above it has
 stopped generating new work.
 
Documentation/filesystems/hpfs.rst +0 -0
index 7e0dd2f4373e..e2a0872a577d 100644

Documentation/filesystems/hpfs.rst are case sensitive, so for example when you create a file FOO, you can use · line 68

Quoted 5 lines
Documentation/filesystems/hpfs.rst +1 -1
@@ -65,7 +65,7 @@ are case sensitive, so for example when you create a file FOO, you can use
 'cat FOO', 'cat Foo', 'cat foo' or 'cat F*' but not 'cat f*'. Note, that you
 also won't be able to compile linux kernel (and maybe other things) on HPFS
 because kernel creates different files with names like bootsect.S and
-bootsect.s. When searching for file thats name has characters >= 128, codepages
+bootsect.s. When searching for file that's name has characters >= 128, codepages

That's not a good change. A different patch has already been accepted for this. See https://lore.kernel.org/all/[email protected]/
and Jon (the docs maintainer) replied that he had merged the patch.

Documentation/filesystems/smb/cifsroot.rst Export root file system as a Samba share in smb.conf file:: · line 85

Quoted 13 lines
Documentation/filesystems/hpfs.rst +0 -0
 are used - see below.
 OS/2 ignores dots and spaces at the end of file name, so this driver does as
 well. If you create 'a. ...', the file 'a' will be created, but you can still
Documentation/filesystems/smb/cifsroot.rst +1 -1
index bf2d9db3acb9..8e8c3fb8739a 100644
@@ -82,7 +82,7 @@ Export root file system as a Samba share in smb.conf file::
 	    guest ok = yes
 	    force user = root
 	    force group = root
-	    browseable = yes
+	    browsable = yes

$iinternet says either spelling is acceptable.

Quoted 8 lines
Documentation/filesystems/smb/cifsroot.rst +0 -0
 	    writeable = yes
 	    admin users = root
 	    public = yes
Documentation/filesystems/vfat.rst +0 -0
index b289c4449cd0..f408699ce50f 100644

Documentation/filesystems/vfat.rst the following: · line 367

Quoted 8 lines
Documentation/filesystems/vfat.rst +1 -1
@@ -361,7 +361,7 @@ the following:
 
                 <proceeding files...>
                 <slot #3, id = 0x43, characters = "h is long">
-                <slot #2, id = 0x02, characters = "xtension whic">
+                <slot #2, id = 0x02, characters = "xtension which">
                 <slot #1, id = 0x01, characters = "My Big File.E">
                 <directory entry, name = "MYBIGFIL.EXT">
 

Nak. The filename is split up into 12-char fields.

What kernel version is this patch made against?
Always check/use the latest current linux-next tree (that would catch many changes) or for Documentation, the latest docs-next tree.

thanks.

Signature · 1 line
~Randy
#2 lore raw

Hi Randy,

Thank you for your feedback and for pointing out the already merged changes. I understand now that some of my proposed fixes are redundant. I’ll make sure to review the latest docs-next tree before submitting any future documentation patches.

I appreciate your guidance and the time you took to explain this.

Best regards,
Methari Hari Krishna

Quoted 109 lines · Randy Dunlap

Hi,

Quoted 19 lines · Methari Hari Krishna

Fixed minor spelling and grammar mistakes in:
- bcachefs/future/idle_work.rst
- hpfs.rst
- smb/cifsroot.rst
- vfat.rst

---
 Documentation/filesystems/bcachefs/future/idle_work.rst | 6 +++---
 Documentation/filesystems/hpfs.rst                      | 2 +-
 Documentation/filesystems/smb/cifsroot.rst              | 2 +-
 Documentation/filesystems/vfat.rst                      | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)
Documentation/filesystems/bcachefs/future/idle_work.rst +0 -0
index 59a332509dcd..f1202113dde0 100644

Documentation/filesystems/bcachefs/future/idle_work.rst idle" so the system can go to sleep. We don't want to be dribbling out · line 17

Quoted 9 lines
Documentation/filesystems/bcachefs/future/idle_work.rst +2 -2
@@ -11,10 +11,10 @@ idle" so the system can go to sleep. We don't want to be dribbling out
 background work while the system should be idle.
 
 The complicating factor is that there are a number of background tasks, which
-form a heirarchy (or a digraph, depending on how you divide it up) - one
+form a hierarchy (or a digraph, depending on how you divide it up) - one
 background task may generate work for another.
 
-Thus proper idle detection needs to model this heirarchy.
+Thus proper idle detection needs to model this hierarchy.

There is already a patch for this but I can't tell that it has been merged yet.

https://lore.kernel.org/all/aFB1tGW3Iwf0isZ3@itsmeut/

Quoted 17 lines
Documentation/filesystems/bcachefs/future/idle_work.rst +1 -1
 - Foreground writes
 - Page cache writeback
@@ -51,7 +51,7 @@ IDLE REGIME
 When the system becomes idle, we should start flushing our pending work
 quicker so the system can go to sleep.
 
-Note that the definition of "idle" depends on where in the heirarchy a task
+Note that the definition of "idle" depends on where in the hierarchy a task
 is - a task should start flushing work more quickly when the task above it has
 stopped generating new work.
 
Documentation/filesystems/hpfs.rst +0 -0
index 7e0dd2f4373e..e2a0872a577d 100644

Documentation/filesystems/hpfs.rst are case sensitive, so for example when you create a file FOO, you can use · line 68

Quoted 5 lines
Documentation/filesystems/hpfs.rst +1 -1
@@ -65,7 +65,7 @@ are case sensitive, so for example when you create a file FOO, you can use
 'cat FOO', 'cat Foo', 'cat foo' or 'cat F*' but not 'cat f*'. Note, that you
 also won't be able to compile linux kernel (and maybe other things) on HPFS
 because kernel creates different files with names like bootsect.S and
-bootsect.s. When searching for file thats name has characters >= 128, codepages
+bootsect.s. When searching for file that's name has characters >= 128, codepages

That's not a good change. A different patch has already been accepted for this. See https://lore.kernel.org/all/[email protected]/
and Jon (the docs maintainer) replied that he had merged the patch.

Documentation/filesystems/smb/cifsroot.rst Export root file system as a Samba share in smb.conf file:: · line 85

Quoted 13 lines
Documentation/filesystems/hpfs.rst +0 -0
 are used - see below.
 OS/2 ignores dots and spaces at the end of file name, so this driver does as
 well. If you create 'a. ...', the file 'a' will be created, but you can still
Documentation/filesystems/smb/cifsroot.rst +1 -1
index bf2d9db3acb9..8e8c3fb8739a 100644
@@ -82,7 +82,7 @@ Export root file system as a Samba share in smb.conf file::
          guest ok = yes
          force user = root
          force group = root
-         browseable = yes
+         browsable = yes

$iinternet says either spelling is acceptable.

Quoted 8 lines
Documentation/filesystems/smb/cifsroot.rst +0 -0
          writeable = yes
          admin users = root
          public = yes
Documentation/filesystems/vfat.rst +0 -0
index b289c4449cd0..f408699ce50f 100644

Documentation/filesystems/vfat.rst the following: · line 367

Quoted 8 lines
Documentation/filesystems/vfat.rst +1 -1
@@ -361,7 +361,7 @@ the following:
 
                 <proceeding files...>
                 <slot #3, id = 0x43, characters = "h is long">
-                <slot #2, id = 0x02, characters = "xtension whic">
+                <slot #2, id = 0x02, characters = "xtension which">
                 <slot #1, id = 0x01, characters = "My Big File.E">
                 <directory entry, name = "MYBIGFIL.EXT">
 

Nak. The filename is split up into 12-char fields.

What kernel version is this patch made against?
Always check/use the latest current linux-next tree (that would catch many changes) or for Documentation, the latest docs-next tree.

thanks.
--
~Randy

maintainer
#3 lore raw
In reply to Methari Hari Krishna

Documentation/filesystems/vfat.rst the following: · line 367

Quoted 13 lines · Methari Hari Krishna
Documentation/filesystems/vfat.rst +1 -1
index b289c4449cd0..f408699ce50f 100644
@@ -361,7 +361,7 @@ the following:
 
                 <proceeding files...>
                 <slot #3, id = 0x43, characters = "h is long">
-                <slot #2, id = 0x02, characters = "xtension whic">
+                <slot #2, id = 0x02, characters = "xtension which">
                 <slot #1, id = 0x01, characters = "My Big File.E">
                 <directory entry, name = "MYBIGFIL.EXT">
 

This change is actively wrong. Please, make an effort to truly understand the text you are modifying before "fixing" things.

Thanks,

jon

#4 lore raw

Hi Jon,

Thank you for clarifying. I realize now that my change was incorrect. I’ll be more careful and make sure I fully understand the context before submitting further patches.

Best regards,
Methari Hari Krishna

Quoted 23 lines · Jonathan Corbet

Documentation/filesystems/vfat.rst the following: · line 367

Quoted 13 lines · Methari Hari Krishna
Documentation/filesystems/vfat.rst +1 -1
index b289c4449cd0..f408699ce50f 100644
@@ -361,7 +361,7 @@ the following:
 
                 <proceeding files...>
                 <slot #3, id = 0x43, characters = "h is long">
-                <slot #2, id = 0x02, characters = "xtension whic">
+                <slot #2, id = 0x02, characters = "xtension which">
                 <slot #1, id = 0x01, characters = "My Big File.E">
                 <directory entry, name = "MYBIGFIL.EXT">
 

This change is actively wrong. Please, make an effort to truly understand the text you are modifying before "fixing" things.

Thanks,

jon