From 4f858546e1c3c452f400a34198b10cb7a1ed2760 Mon Sep 17 00:00:00 2001 From: Theodore Ts'o Date: Sat, 30 May 2009 12:34:28 -0400 Subject: [PATCH] Update man pages to include ext4 in the synposis, instead of just "ext2/ext3" The e2fsprogs programs have historically just said that they operate on ext2 and ext3 file system in their man pages. Update them to say that they also operate on ext4 file systems. Addresses-Launchpad-bug: #381854 Signed-off-by: "Theodore Ts'o" --- debugfs/debugfs.8.in | 6 +++--- e2fsck/e2fsck.8.in | 18 +++++++----------- misc/chattr.1.in | 4 ++-- misc/dumpe2fs.8.in | 2 +- misc/e2image.8.in | 4 ++-- misc/e2label.8.in | 5 +++-- misc/mke2fs.8.in | 5 +++-- misc/tune2fs.8.in | 6 +++--- resize/resize2fs.8.in | 6 +++--- 9 files changed, 27 insertions(+), 29 deletions(-) diff --git a/debugfs/debugfs.8.in b/debugfs/debugfs.8.in index 8e6468f05..4dcc48b82 100644 --- a/debugfs/debugfs.8.in +++ b/debugfs/debugfs.8.in @@ -4,7 +4,7 @@ .\" .TH DEBUGFS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -debugfs \- ext2/ext3 file system debugger +debugfs \- ext2/ext3/ext4 file system debugger .SH SYNOPSIS .B debugfs [ @@ -37,10 +37,10 @@ device The .B debugfs program is an interactive file system debugger. It can be used to -examine and change the state of an ext2 file system. +examine and change the state of an ext2, ext3, or ext4 file system. .br .I device -is the special file corresponding to the device containing the ext2 +is the special file corresponding to the device containing the file system (e.g /dev/hdXX). .SH OPTIONS .TP diff --git a/e2fsck/e2fsck.8.in b/e2fsck/e2fsck.8.in index 7f754524b..a97017360 100644 --- a/e2fsck/e2fsck.8.in +++ b/e2fsck/e2fsck.8.in @@ -4,7 +4,7 @@ .\" .TH E2FSCK 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -e2fsck \- check a Linux ext2/ext3 file system +e2fsck \- check a Linux ext2/ext3/ext4 file system .SH SYNOPSIS .B e2fsck [ @@ -37,17 +37,13 @@ e2fsck \- check a Linux ext2/ext3 file system .I device .SH DESCRIPTION .B e2fsck -is used to check a Linux second extended file system (ext2fs). -.B E2fsck -also -supports ext2 filesystems containing a journal, which are -also sometimes known as ext3 filesystems, by first applying the journal -to the filesystem before continuing with normal +is used to check the ext2/ext3/ext4 family of file systems. +For ext3 and ext4 filesystems that use a journal, if the system has been +shut down uncleanly without any errors, normally, after replaying the +committed transactions in the journal, the file system should be +marked as clean. Hence, for filesystems that use journalling, .B e2fsck -processing. After the journal has been applied, a filesystem will -normally be marked as clean. Hence, for ext3 filesystems, -.B e2fsck -will normally run the journal and exit, unless its superblock +will normally replay the journal and exit, unless its superblock indicates that further checking is required. .PP .I device diff --git a/misc/chattr.1.in b/misc/chattr.1.in index 63bd5b655..2b5955b6f 100644 --- a/misc/chattr.1.in +++ b/misc/chattr.1.in @@ -1,7 +1,7 @@ .\" -*- nroff -*- .TH CHATTR 1 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -chattr \- change file attributes on a Linux second extended file system +chattr \- change file attributes on a Linux file system .SH SYNOPSIS .B chattr [ @@ -17,7 +17,7 @@ chattr \- change file attributes on a Linux second extended file system .I files... .SH DESCRIPTION .B chattr -changes the file attributes on a Linux second extended file system. +changes the file attributes on a Linux file system. .PP The format of a symbolic mode is +-=[acdeijstuADST]. .PP diff --git a/misc/dumpe2fs.8.in b/misc/dumpe2fs.8.in index 79cf86382..c1dfcbd7f 100644 --- a/misc/dumpe2fs.8.in +++ b/misc/dumpe2fs.8.in @@ -4,7 +4,7 @@ .\" .TH DUMPE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -dumpe2fs \- dump ext2/ext3 filesystem information +dumpe2fs \- dump ext2/ext3/ext4 filesystem information .SH SYNOPSIS .B dumpe2fs [ diff --git a/misc/e2image.8.in b/misc/e2image.8.in index a0300b447..e18a30b50 100644 --- a/misc/e2image.8.in +++ b/misc/e2image.8.in @@ -4,7 +4,7 @@ .\" .TH E2IMAGE 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -e2image \- Save critical ext2/ext3 filesystem metadata to a file +e2image \- Save critical ext2/ext3/ext4 filesystem metadata to a file .SH SYNOPSIS .B e2image [ @@ -15,7 +15,7 @@ e2image \- Save critical ext2/ext3 filesystem metadata to a file .SH DESCRIPTION The .B e2image -program will save critical ext2 or ext3 filesystem metadata located on +program will save critical ext2, ext3, or ext4 filesystem metadata located on .I device to a file specified by .IR image-file . diff --git a/misc/e2label.8.in b/misc/e2label.8.in index 8040de2d5..aff08d9cd 100644 --- a/misc/e2label.8.in +++ b/misc/e2label.8.in @@ -4,7 +4,7 @@ .\" .TH E2LABEL 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -e2label \- Change the label on an ext2/ext3 filesystem +e2label \- Change the label on an ext2/ext3/ext4 filesystem .SH SYNOPSIS .B e2label .I device @@ -13,7 +13,8 @@ e2label \- Change the label on an ext2/ext3 filesystem ] .SH DESCRIPTION .B e2label -will display or change the filesystem label on the ext2 filesystem located on +will display or change the filesystem label on the ext2, ext3, or ext4 +filesystem located on .I device. .PP If the optional argument diff --git a/misc/mke2fs.8.in b/misc/mke2fs.8.in index d638286f2..1575b0895 100644 --- a/misc/mke2fs.8.in +++ b/misc/mke2fs.8.in @@ -4,7 +4,7 @@ .\" .TH MKE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -mke2fs \- create an ext2/ext3 filesystem +mke2fs \- create an ext2/ext3/ext4 filesystem .SH SYNOPSIS .B mke2fs [ @@ -140,7 +140,8 @@ mke2fs \- create an ext2/ext3 filesystem @JDEV@] .SH DESCRIPTION .B mke2fs -is used to create an ext2/ext3 filesystem (usually in a disk partition). +is used to create an ext2, ext3, or ext4 filesystem, usually in a disk +partition. .I device is the special file corresponding to the device (e.g .IR /dev/hdXX ). diff --git a/misc/tune2fs.8.in b/misc/tune2fs.8.in index 253035cff..4abc728b7 100644 --- a/misc/tune2fs.8.in +++ b/misc/tune2fs.8.in @@ -4,7 +4,7 @@ .\" .TH TUNE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -tune2fs \- adjust tunable filesystem parameters on ext2/ext3 filesystems +tune2fs \- adjust tunable filesystem parameters on ext2/ext3/ext4 filesystems .SH SYNOPSIS .B tune2fs [ @@ -88,8 +88,8 @@ device .SH DESCRIPTION .BI tune2fs allows the system administrator to adjust various tunable filesystem -parameters on Linux ext2/ext3 filesystems. The current values of these -options can be displayed by using the +parameters on Linux ext2, ext3, or ext4 filesystems. The current values +of these options can be displayed by using the .B -l option to .BR tune2fs (8) diff --git a/resize/resize2fs.8.in b/resize/resize2fs.8.in index ebd8e7829..3ea7a6308 100644 --- a/resize/resize2fs.8.in +++ b/resize/resize2fs.8.in @@ -4,7 +4,7 @@ .\" .TH RESIZE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .TH RESIZE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME -resize2fs \- ext2/ext3 file system resizer +resize2fs \- ext2/ext3/ext4 file system resizer .SH SYNOPSIS .B resize2fs [ @@ -25,8 +25,8 @@ resize2fs \- ext2/ext3 file system resizer .SH DESCRIPTION The .B resize2fs -program will resize ext2 or ext3 file systems. It can be used to enlarge or -shrink an unmounted file system located on +program will resize ext2, ext3, or ext4 file systems. It can be used to +enlarge or shrink an unmounted file system located on .IR device . If the filesystem is mounted, it can be used to expand the size of the mounted filesystem, assuming the kernel supports on-line resizing. (As -- 2.39.2