linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: Fix typos in filesystems
@ 2025-08-30 19:12 Methari Hari Krishna
  2025-08-30 21:01 ` Randy Dunlap
  2025-08-30 21:41 ` Jonathan Corbet
  0 siblings, 2 replies; 5+ messages in thread
From: Methari Hari Krishna @ 2025-08-30 19:12 UTC (permalink / raw)
  To: linux-doc
  Cc: Jonathan Corbet, Christian Brauner, Darrick J . Wong,
	Methari Hari Krishna

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

Signed-off-by: Methari Hari Krishna <harikrishnamethari@gmail.com>
---
 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(-)

diff --git a/Documentation/filesystems/bcachefs/future/idle_work.rst b/Documentation/filesystems/bcachefs/future/idle_work.rst
index 59a332509dcd..f1202113dde0 100644
--- a/Documentation/filesystems/bcachefs/future/idle_work.rst
+++ b/Documentation/filesystems/bcachefs/future/idle_work.rst
@@ -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.
 
diff --git a/Documentation/filesystems/hpfs.rst b/Documentation/filesystems/hpfs.rst
index 7e0dd2f4373e..e2a0872a577d 100644
--- a/Documentation/filesystems/hpfs.rst
+++ b/Documentation/filesystems/hpfs.rst
@@ -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
diff --git a/Documentation/filesystems/smb/cifsroot.rst b/Documentation/filesystems/smb/cifsroot.rst
index bf2d9db3acb9..8e8c3fb8739a 100644
--- a/Documentation/filesystems/smb/cifsroot.rst
+++ b/Documentation/filesystems/smb/cifsroot.rst
@@ -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
diff --git a/Documentation/filesystems/vfat.rst b/Documentation/filesystems/vfat.rst
index b289c4449cd0..f408699ce50f 100644
--- a/Documentation/filesystems/vfat.rst
+++ b/Documentation/filesystems/vfat.rst
@@ -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">
 
-- 
2.51.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] Documentation: Fix typos in filesystems
  2025-08-30 19:12 [PATCH] Documentation: Fix typos in filesystems Methari Hari Krishna
@ 2025-08-30 21:01 ` Randy Dunlap
  2025-08-30 21:19   ` Hari Krishna Methari
  2025-08-30 21:41 ` Jonathan Corbet
  1 sibling, 1 reply; 5+ messages in thread
From: Randy Dunlap @ 2025-08-30 21:01 UTC (permalink / raw)
  To: Methari Hari Krishna, linux-doc
  Cc: Jonathan Corbet, Christian Brauner, Darrick J . Wong

Hi,

On 8/30/25 12:12 PM, Methari Hari Krishna wrote:
> Fixed minor spelling and grammar mistakes in:
> - bcachefs/future/idle_work.rst
> - hpfs.rst
> - smb/cifsroot.rst
> - vfat.rst
> 
> Signed-off-by: Methari Hari Krishna <harikrishnamethari@gmail.com>
> ---
>  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(-)
> 
> diff --git a/Documentation/filesystems/bcachefs/future/idle_work.rst b/Documentation/filesystems/bcachefs/future/idle_work.rst
> index 59a332509dcd..f1202113dde0 100644
> --- a/Documentation/filesystems/bcachefs/future/idle_work.rst
> +++ b/Documentation/filesystems/bcachefs/future/idle_work.rst
> @@ -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/


>  
>  - 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.
>  
> diff --git a/Documentation/filesystems/hpfs.rst b/Documentation/filesystems/hpfs.rst
> index 7e0dd2f4373e..e2a0872a577d 100644
> --- a/Documentation/filesystems/hpfs.rst
> +++ b/Documentation/filesystems/hpfs.rst
> @@ -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/20250813200526.290420-6-helgaas@kernel.org/
and Jon (the docs maintainer) replied that he had merged the patch.


>  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
> diff --git a/Documentation/filesystems/smb/cifsroot.rst b/Documentation/filesystems/smb/cifsroot.rst
> index bf2d9db3acb9..8e8c3fb8739a 100644
> --- a/Documentation/filesystems/smb/cifsroot.rst
> +++ b/Documentation/filesystems/smb/cifsroot.rst
> @@ -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.

>  	    writeable = yes
>  	    admin users = root
>  	    public = yes
> diff --git a/Documentation/filesystems/vfat.rst b/Documentation/filesystems/vfat.rst
> index b289c4449cd0..f408699ce50f 100644
> --- a/Documentation/filesystems/vfat.rst
> +++ b/Documentation/filesystems/vfat.rst
> @@ -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


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] Documentation: Fix typos in filesystems
  2025-08-30 21:01 ` Randy Dunlap
@ 2025-08-30 21:19   ` Hari Krishna Methari
  0 siblings, 0 replies; 5+ messages in thread
From: Hari Krishna Methari @ 2025-08-30 21:19 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-doc, Jonathan Corbet, Christian Brauner, Darrick J . Wong

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


On Sun, Aug 31, 2025 at 2:31 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Hi,
>
> On 8/30/25 12:12 PM, Methari Hari Krishna wrote:
> > Fixed minor spelling and grammar mistakes in:
> > - bcachefs/future/idle_work.rst
> > - hpfs.rst
> > - smb/cifsroot.rst
> > - vfat.rst
> >
> > Signed-off-by: Methari Hari Krishna <harikrishnamethari@gmail.com>
> > ---
> >  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(-)
> >
> > diff --git a/Documentation/filesystems/bcachefs/future/idle_work.rst b/Documentation/filesystems/bcachefs/future/idle_work.rst
> > index 59a332509dcd..f1202113dde0 100644
> > --- a/Documentation/filesystems/bcachefs/future/idle_work.rst
> > +++ b/Documentation/filesystems/bcachefs/future/idle_work.rst
> > @@ -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/
>
>
> >
> >  - 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.
> >
> > diff --git a/Documentation/filesystems/hpfs.rst b/Documentation/filesystems/hpfs.rst
> > index 7e0dd2f4373e..e2a0872a577d 100644
> > --- a/Documentation/filesystems/hpfs.rst
> > +++ b/Documentation/filesystems/hpfs.rst
> > @@ -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/20250813200526.290420-6-helgaas@kernel.org/
> and Jon (the docs maintainer) replied that he had merged the patch.
>
>
> >  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
> > diff --git a/Documentation/filesystems/smb/cifsroot.rst b/Documentation/filesystems/smb/cifsroot.rst
> > index bf2d9db3acb9..8e8c3fb8739a 100644
> > --- a/Documentation/filesystems/smb/cifsroot.rst
> > +++ b/Documentation/filesystems/smb/cifsroot.rst
> > @@ -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.
>
> >           writeable = yes
> >           admin users = root
> >           public = yes
> > diff --git a/Documentation/filesystems/vfat.rst b/Documentation/filesystems/vfat.rst
> > index b289c4449cd0..f408699ce50f 100644
> > --- a/Documentation/filesystems/vfat.rst
> > +++ b/Documentation/filesystems/vfat.rst
> > @@ -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
>

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] Documentation: Fix typos in filesystems
  2025-08-30 19:12 [PATCH] Documentation: Fix typos in filesystems Methari Hari Krishna
  2025-08-30 21:01 ` Randy Dunlap
@ 2025-08-30 21:41 ` Jonathan Corbet
  2025-08-30 21:45   ` Hari Krishna Methari
  1 sibling, 1 reply; 5+ messages in thread
From: Jonathan Corbet @ 2025-08-30 21:41 UTC (permalink / raw)
  To: Methari Hari Krishna, linux-doc
  Cc: Christian Brauner, Darrick J . Wong, Methari Hari Krishna

Methari Hari Krishna <harikrishnamethari@gmail.com> writes:

> diff --git a/Documentation/filesystems/vfat.rst b/Documentation/filesystems/vfat.rst
> index b289c4449cd0..f408699ce50f 100644
> --- a/Documentation/filesystems/vfat.rst
> +++ b/Documentation/filesystems/vfat.rst
> @@ -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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] Documentation: Fix typos in filesystems
  2025-08-30 21:41 ` Jonathan Corbet
@ 2025-08-30 21:45   ` Hari Krishna Methari
  0 siblings, 0 replies; 5+ messages in thread
From: Hari Krishna Methari @ 2025-08-30 21:45 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: linux-doc, Christian Brauner, Darrick J . Wong

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

On Sun, Aug 31, 2025 at 3:11 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> Methari Hari Krishna <harikrishnamethari@gmail.com> writes:
>
> > diff --git a/Documentation/filesystems/vfat.rst b/Documentation/filesystems/vfat.rst
> > index b289c4449cd0..f408699ce50f 100644
> > --- a/Documentation/filesystems/vfat.rst
> > +++ b/Documentation/filesystems/vfat.rst
> > @@ -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

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2025-08-30 21:45 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-30 19:12 [PATCH] Documentation: Fix typos in filesystems Methari Hari Krishna
2025-08-30 21:01 ` Randy Dunlap
2025-08-30 21:19   ` Hari Krishna Methari
2025-08-30 21:41 ` Jonathan Corbet
2025-08-30 21:45   ` Hari Krishna Methari

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).