fs(5) man page is out of date

fs(5) man page is out of date

[Jeff B]

Hi,

Just FYI the fs(5) man page is woefully out of date.  The version on your
website at http://www.kernel.org/doc/man-pages/online/pages/man5/fs.5.html,
dated 2007-12-14, does not mention EXT4 and NTFS, among other things.

Thanks,
Jeff Barry


--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Petr Baudis]

  Hi!

On Tue, May 18, 2010 at 12:05:36PM -0400, Jeff B wrote:
> Just FYI the fs(5) man page is woefully out of date.  The version on your
> website at http://www.kernel.org/doc/man-pages/online/pages/man5/fs.5.html,
> dated 2007-12-14, does not mention EXT4 and NTFS, among other things.

  Patches are welcome.

  Kind regards,

				Petr "Pasky" Baudis
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Jeff B]

[-- Attachment #1: Type: text/plain, Size: 924 bytes --]


> On 05/18/2010 02:56 PM, Petr Baudis wrote:
>
> Hi!
>
> On Tue, May 18, 2010 at 12:05:36PM -0400, Jeff B wrote:
>    
>> Just FYI the fs(5) man page is woefully out of date.  The version on your
>> website at http://www.kernel.org/doc/man-pages/online/pages/man5/fs.5.html,
>> dated 2007-12-14, does not mention EXT4 and NTFS, among other things.
>>      
>    Patches are welcome.
>
>    Kind regards,
> 				Petr "Pasky" Baudis
>    

OK, you want a patch, you get a patch.   This is against the latest
version, man-pages-3.24, of the filesystems.5 man page.  I added
references to ext4 and ntfs by condensing information I took from
the Wikipedia pages for those file systems.

I hope it is acceptable that I attached the patch in diff -u format;
pasting it into this eMail was converting tabs into spaces.

>  cksum  filesystems.5.2010-05-19.new.patch.u
55916840 1656 filesystems.5.2010-05-19.new.patch.u


Jeff Barry


[-- Attachment #2: filesystems.5.2010-05-19.new.patch.u --]
[-- Type: text/plain, Size: 1656 bytes --]

--- filesystems.5.man-pages-3.24.ori	2010-02-25 23:46:53.000000000 -0500
+++ filesystems.5.2010-05-19.new	2010-05-19 15:08:55.653199451 -0400
@@ -22,12 +22,14 @@
 .\"
 .\" 2007-12-14 mtk Added Reiserfs, XFS, JFS.
 .\"
-.TH FILESYSTEMS 5 2007-12-14 "Linux" "Linux Programmer's Manual"
+.\" 2010-05-19 Jeff Barry, Added ext4 and ntfs.
+.\"
+.TH FILESYSTEMS 5 2010-05-19 "Linux" "Linux Programmer's Manual"
 .nh
 .SH NAME
-filesystems \- Linux file-system types: minix, ext, ext2, ext3, Reiserfs,
+filesystems \- Linux file-system types: minix, ext, ext2, ext3, ext4, Reiserfs,
 XFS, JFS, xia, msdos,
-umsdos, vfat, proc, nfs, iso9660, hpfs, sysv, smb, ncpfs
+umsdos, vfat, ntfs, proc, nfs, iso9660, hpfs, sysv, smb, ncpfs
 .SH DESCRIPTION
 When, as is customary, the
 .B proc
@@ -77,6 +79,9 @@
 It is easy to
 switch back and forth between ext2 and ext3.
 .TP
+.B ext4
+is a set of upgrades to ext3 including substantial performance and reliability enhancements, plus huge increases in volume, file, and directory size limits.
+.TP
 .B Reiserfs
 is a journaling file system, designed by Hans Reiser,
 that was integrated into Linux in kernel 2.4.1.
@@ -116,6 +121,9 @@
 is an extended DOS file system used by Microsoft Windows95 and Windows NT.
 VFAT adds the capability to use long filenames under the MSDOS file system.
 .TP
+.B ntfs
+replaces Microsoft Window's *FAT* file systems (eg VFAT, FAT32).  It has reliability, performance, and space utilization enhancements plus features like ACLs, journaling, encryption, etc.
+.TP
 .B proc
 is a pseudo file system which is used as an interface to kernel data
 structures rather than reading and interpreting

Re: fs(5) man page is out of date

[Petr Baudis]

On Wed, May 19, 2010 at 03:31:55PM -0400, Jeff B wrote:
> 
> >On 05/18/2010 02:56 PM, Petr Baudis wrote:
> >
> >Hi!
> >
> >On Tue, May 18, 2010 at 12:05:36PM -0400, Jeff B wrote:
> >>Just FYI the fs(5) man page is woefully out of date.  The version on your
> >>website at http://www.kernel.org/doc/man-pages/online/pages/man5/fs.5.html,
> >>dated 2007-12-14, does not mention EXT4 and NTFS, among other things.
> >   Patches are welcome.
> >
> >   Kind regards,
> >				Petr "Pasky" Baudis
> 
> OK, you want a patch, you get a patch.   This is against the latest
> version, man-pages-3.24, of the filesystems.5 man page.  I added
> references to ext4 and ntfs by condensing information I took from
> the Wikipedia pages for those file systems.
> 
> I hope it is acceptable that I attached the patch in diff -u format;
> pasting it into this eMail was converting tabs into spaces.
> 
> > cksum  filesystems.5.2010-05-19.new.patch.u
> 55916840 1656 filesystems.5.2010-05-19.new.patch.u

Thanks! I hope mtk will be able to apply it - one thing that is
essential is that you sign off your patch, confirming that you are the
copyright holder and release your changes under the appropriate licence;
sending a

	Signed-off-by: Jeff FullName <JeffBatHome-yboC7gn3QBoJzESkhhYsnQ@public.gmane.org>

line will do.

(It would be also nice to get a short subject + commit text in the mail,
but mtk or me can also supply one in case you don't.)

> --- filesystems.5.man-pages-3.24.ori	2010-02-25 23:46:53.000000000 -0500
> +++ filesystems.5.2010-05-19.new	2010-05-19 15:08:55.653199451 -0400
> @@ -22,12 +22,14 @@
>  .\"
>  .\" 2007-12-14 mtk Added Reiserfs, XFS, JFS.
>  .\"
> -.TH FILESYSTEMS 5 2007-12-14 "Linux" "Linux Programmer's Manual"
> +.\" 2010-05-19 Jeff Barry, Added ext4 and ntfs.
> +.\"
> +.TH FILESYSTEMS 5 2010-05-19 "Linux" "Linux Programmer's Manual"
>  .nh
>  .SH NAME

FYI, we have stopped adding change entries in the file headers.

-- 
				Petr "Pasky" Baudis
When I feel like exercising, I just lie down until the feeling
goes away.  -- xed_over
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Jeff B]

> On 05/19/2010 03:39 PM, Petr Baudis wrote:
> Thanks! I hope mtk will be able to apply it -

Who or what is "mtk"?



> one thing that is
> essential is that you sign off your patch, confirming that you are the
> copyright holder and release your changes under the appropriate licence;
> sending a
>
> 	Signed-off-by: Jeff FullName<JeffBatHome-yboC7gn3QBoJzESkhhYsnQ@public.gmane.org>
>
> line will do.
>    


Yes, I made the changes, and the world is welcomed to them.

Signed-off-by: Jeff Barry <JeffBatHome-yboC7gn3QBoJzESkhhYsnQ@public.gmane.org>



> (It would be also nice to get a short subject + commit text in the mail,
> but mtk or me can also supply one in case you don't.)
>    

-m "Added references to ext4 and ntfs file systems."


> FYI, we have stopped adding change entries in the file headers.
>    


You mean I don't get to have my name embedded in a man page
source file forever?   :-)


Peace,
Jeff Barry
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Mike Frysinger]

[-- Attachment #1: Type: Text/Plain, Size: 278 bytes --]

On Wednesday 19 May 2010 16:40:29 Jeff B wrote:
> > On 05/19/2010 03:39 PM, Petr Baudis wrote:
> > Thanks! I hope mtk will be able to apply it -
> 
> Who or what is "mtk"?

he is the man pages maintainer

please dont bcc the mailing lists.  it screws things up.
-mike

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 836 bytes --]

Re: fs(5) man page is out of date

[Michael Kerrisk]

On Thu, May 20, 2010 at 12:23 AM, Mike Frysinger <vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org> wrote:
> On Wednesday 19 May 2010 16:40:29 Jeff B wrote:
>> > On 05/19/2010 03:39 PM, Petr Baudis wrote:
>> > Thanks! I hope mtk will be able to apply it -
>>
>> Who or what is "mtk"?
>
> he is the man pages maintainer
>
> please dont bcc the mailing lists.  it screws things up.

Yep. Please don't do that.

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface" http://blog.man7.org/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Michael Kerrisk]

Hi Jeff,

On Wed, May 19, 2010 at 9:31 PM, Jeff B <JeffBatHome-XMwiTyDR5eL3nsQPz6zGkQ@public.gmane.org> wrote:
>
>> On 05/18/2010 02:56 PM, Petr Baudis wrote:
>>
>> Hi!
>>
>> On Tue, May 18, 2010 at 12:05:36PM -0400, Jeff B wrote:
>>
>>>
>>> Just FYI the fs(5) man page is woefully out of date.  The version on your
>>> website at
>>> http://www.kernel.org/doc/man-pages/online/pages/man5/fs.5.html,
>>> dated 2007-12-14, does not mention EXT4 and NTFS, among other things.
>>>
>>
>>   Patches are welcome.
>>
>>   Kind regards,
>>                                Petr "Pasky" Baudis
>>
>
> OK, you want a patch, you get a patch.   This is against the latest
> version, man-pages-3.24, of the filesystems.5 man page.  I added
> references to ext4 and ntfs by condensing information I took from
> the Wikipedia pages for those file systems.
>
> I hope it is acceptable that I attached the patch in diff -u format;
> pasting it into this eMail was converting tabs into spaces.

Inline is best. There's usually a way to do this in most mail clients
(though not always obvious).

Thanks for the patch! I tweaked it a little, and applied the form below.

The change will be in man-pages-3.25.

Cheers,

Michael

--- a/man5/filesystems.5
+++ b/man5/filesystems.5
@@ -22,12 +22,12 @@
 .\"
 .\" 2007-12-14 mtk Added Reiserfs, XFS, JFS.
 .\"
-.TH FILESYSTEMS 5 2007-12-14 "Linux" "Linux Programmer's Manual"
+.TH FILESYSTEMS 5 2010-05-24 "Linux" "Linux Programmer's Manual"
 .nh
 .SH NAME
-filesystems \- Linux file-system types: minix, ext, ext2, ext3, Reiserfs,
+filesystems \- Linux file-system types: minix, ext, ext2, ext3, ext4, Reiserfs,
 XFS, JFS, xia, msdos,
-umsdos, vfat, proc, nfs, iso9660, hpfs, sysv, smb, ncpfs
+umsdos, vfat, ntfs, proc, nfs, iso9660, hpfs, sysv, smb, ncpfs
 .SH DESCRIPTION
 When, as is customary, the
 .B proc
@@ -77,6 +77,12 @@ is a journaling version of the ext2 file system.
 It is easy to
 switch back and forth between ext2 and ext3.
 .TP
+.B ext4
+is a set of upgrades to ext3 including substantial performance and
+reliability enhancements,
+plus large increases in volume, file, and directory size limits.
+.TP
+ .B Reiserfs
 .B Reiserfs
 is a journaling file system, designed by Hans Reiser,
 that was integrated into Linux in kernel 2.4.1.
@@ -116,6 +122,11 @@ sacrificing compatibility with DOS.
 is an extended DOS file system used by Microsoft Windows95 and Windows NT.
 VFAT adds the capability to use long filenames under the MSDOS file system.
 .TP
+.B ntfs
+replaces Microsoft Window's FAT file systems (VFAT, FAT32).
+It has reliability, performance, and space-utilization enhancements
+plus features like ACLs, journaling, encryption, and so on.
+.TP
 .B proc
 is a pseudo file system which is used as an interface to kernel data
 structures rather than reading and interpreting




-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface" http://blog.man7.org/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Petr Baudis]

On Mon, May 24, 2010 at 08:39:12AM +0200, Michael Kerrisk wrote:
> On Thu, May 20, 2010 at 12:23 AM, Mike Frysinger <vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org> wrote:
> > On Wednesday 19 May 2010 16:40:29 Jeff B wrote:
> >> > On 05/19/2010 03:39 PM, Petr Baudis wrote:
> >> > Thanks! I hope mtk will be able to apply it -
> >>
> >> Who or what is "mtk"?
> >
> > he is the man pages maintainer
> >
> > please dont bcc the mailing lists.  it screws things up.
> 
> Yep. Please don't do that.

That was my fault; Jeff B replied only to me in private (apparently by
mistake) so I just bounced off the reply to the mailing list as well,
instead of forwarding it.

				Petr "Pasky" Baudis
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Denis Barbier]

On 2010/5/24 Michael Kerrisk wrote:
[...]
> --- a/man5/filesystems.5
> +++ b/man5/filesystems.5
[...]
> @@ -77,6 +77,12 @@ is a journaling version of the ext2 file system.
>  It is easy to
>  switch back and forth between ext2 and ext3.
>  .TP
> +.B ext4
> +is a set of upgrades to ext3 including substantial performance and
> +reliability enhancements,
> +plus large increases in volume, file, and directory size limits.
> +.TP
> + .B Reiserfs

Hello,

Please remove the line above, it is duplicated and contain a spurious
leading space.

>  .B Reiserfs
>  is a journaling file system, designed by Hans Reiser,
>  that was integrated into Linux in kernel 2.4.1.

Denis
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: fs(5) man page is out of date

[Michael Kerrisk]

Hello Denis,

On Thu, May 27, 2010 at 11:26 PM, Denis Barbier <bouzim-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> On 2010/5/24 Michael Kerrisk wrote:
> [...]
>> --- a/man5/filesystems.5
>> +++ b/man5/filesystems.5
> [...]
>> @@ -77,6 +77,12 @@ is a journaling version of the ext2 file system.
>>  It is easy to
>>  switch back and forth between ext2 and ext3.
>>  .TP
>> +.B ext4
>> +is a set of upgrades to ext3 including substantial performance and
>> +reliability enhancements,
>> +plus large increases in volume, file, and directory size limits.
>> +.TP
>> + .B Reiserfs
>
> Hello,
>
> Please remove the line above, it is duplicated and contain a spurious
> leading space.
>
>>  .B Reiserfs
>>  is a journaling file system, designed by Hans Reiser,
>>  that was integrated into Linux in kernel 2.4.1.

Thanks for catching that. Fixed now.,

Cheers,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface" http://blog.man7.org/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html