mkfs.ocfs2: Update fs-features list in man page
PATCH 1/2 mkfs.ocfs2: Update fs-features list in man page
The list of available options for the fs-features flag in mkfs.ocfs2.8 was out-dated. Update the list by added information on the 'backup-super', 'inline-data' and 'extended-slotmap' options. Also, update the reported list of set features for the --fs-feature-level=default option.
At the same time, we remove the even more out of date list from the tunefs.ocfs2 man page and provide a pointer to the mkfs.ocfs2 man page. This way we only have one place to update.
--- mkfs.ocfs2/mkfs.ocfs2.8.in | 17 ++++++++++++++++- tunefs.ocfs2/tunefs.ocfs2.8.in | 24 +----------------------- 2 files changed, 17 insertions(+), 24 deletions(-)
mkfs.ocfs2/mkfs.ocfs2.8.in +16 -1
@@ -108,6 +108,11 @@ Turn specific file system features on or off. A comma separated list of feature The following flags are supported: .RS 1.2i .TP +\fBbackup-super\fR +When this is set, mkfs.ocfs2 will store a copy of the super block in several known locations so that it can be used for disaster recovery. This feature is fully compatible with all versions of Ocfs2 and generally shouldn't be disabled. +.RE +.RS 1.2i +.TP \fBlocal\fR Create the file system as a local mount, so that it can be mounted without a cluster stack. Available with the file system bundled with Linux kernels 2.6.20 and later. .RE
@@ -126,6 +131,16 @@ Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (an \fBunwritten\fR Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. .RE +.RS 1.2i +.TP +\fBinline-data\fR +Enable inline-data support. If this feature is turned on, Ocfs2 will store small amounts of file and directory data inside of the inode block. Data is transparently moved out to an extent when it no longer fits inside the inode block. In some cases, this can also make a positive impact on cold-cache directory and file operations. +.RE +.RS 1.2i +.TP +\fBextended-slotmap\fR +The slot-map is a hidden file on an Ocfs2 fs which is used to map mounted nodes to system file resources. The extended slot map allows a larger range of possible node numbers, which is useful for userspace cluster stacks. This feature is automatically turned on when needed, thus users have no need to turn this on manually. +.RE .TP \fB\-\-fs\-feature\-level=\fR\fR\fIfeature\-level\fR
@@ -138,7 +153,7 @@ Chooses fewer features but ensures that the file system can be mounted from olde .RS 1.2i .TP \fBdefault\fR -The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR. +The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. .RE .RS 1.2i .TP
tunefs.ocfs2/tunefs.ocfs2.8.in +1 -23
@@ -13,29 +13,7 @@ This tool requires the \fIO2CB\fR cluster to be online. .SH "OPTIONS" .TP \fB\-\-fs\-features=\fR\fR\fI[no]sparse...\fR -Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. -The following features are supported: -.RS 1.2i -.TP -\fBsparse\fR -Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (and zeroing) data to fill holes. Available with the file system bundled with Linux kernels 2.6.22 and later. -.RE -.RS 1.2i -.TP -\fBunwritten\fR -Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. -.RE - -.TP -\fB\-J, \-\-journal\-options\fR \fIoptions\fR -Modify the journal using options specified on the command\-line. -Journal options are comma separated, and may take an argument using -the equals ('=') sign. The following options are supported: -.RS 1.2i -.TP -\fBsize\fR=\fIjournal\-size\fR -Grow the size of journal files for all the slots. Minimum size is 4M. -.RE +Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. For a list of feature names, see the man page for \fBmkfs.ocfs2\fR. .TP \fB\-L, \-\-label\fR \fIvolume\-label\fR
Signature · 1 line
1.5.6
PATCH 2/2 features: Make inline-data a default feature
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
--- libocfs2/feature_string.c | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-)
libocfs2/feature_string.c +2 -1
@@ -62,7 +62,8 @@ static struct feature_level_translation ocfs2_feature_levels_table[] = {static ocfs2_fs_options feature_level_defaults[] = { {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB , -OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC , +OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC | +OCFS2_FEATURE_INCOMPAT_INLINE_DATA ,OCFS2_FEATURE_RO_COMPAT_UNWRITTEN },/* OCFS2_FEATURE_LEVEL_DEFAULT */ {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB ,
Signature · 1 line
1.5.6
PATCH 2/2 features: Make inline-data a default feature
Quoted 4 lines · Mark Fasheh
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
Signed-off-by Mark Fasheh <[email protected]>
Whoops, forgot to add inline-data to the list of default features in the mkfs.ocfs2 man page... Updated patch attached.
--Mark
From: Mark Fasheh <[email protected]>
[PATCH 2/2] features: Make inline-data a default feature
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
--- libocfs2/feature_string.c | 3 ++- mkfs.ocfs2/mkfs.ocfs2.8.in | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-)
libocfs2/feature_string.c +2 -1
@@ -62,7 +62,8 @@ static struct feature_level_translation ocfs2_feature_levels_table[] = {static ocfs2_fs_options feature_level_defaults[] = { {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB , -OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC , +OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC | +OCFS2_FEATURE_INCOMPAT_INLINE_DATA ,OCFS2_FEATURE_RO_COMPAT_UNWRITTEN },/* OCFS2_FEATURE_LEVEL_DEFAULT */ {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB ,
mkfs.ocfs2/mkfs.ocfs2.8.in +1 -1
@@ -153,7 +153,7 @@ Chooses fewer features but ensures that the file system can be mounted from olde .RS 1.2i .TP \fBdefault\fR -The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. +The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR, \fBunwritten\fR and \fBinline-data\fR. .RE .RS 1.2i .TP
Signature · 1 line
1.5.6
PATCH 2/2 features: Make inline-data a default feature
Quoted 50 lines · Mark Fasheh
Quoted 4 lines · Mark Fasheh
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
Signed-off-by Mark Fasheh <[email protected]>Whoops, forgot to add inline-data to the list of default features in the mkfs.ocfs2 man page... Updated patch attached.
--MarkFrom: Mark Fasheh <[email protected]>
[PATCH 2/2] features: Make inline-data a default feature
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
Signed-off-by Mark Fasheh <[email protected]>--- libocfs2/feature_string.c | 3 ++- mkfs.ocfs2/mkfs.ocfs2.8.in | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-)libocfs2/feature_string.c +2
-1@@ -62,7 +62,8 @@ static struct feature_level_translation ocfs2_feature_levels_table[] = {static ocfs2_fs_options feature_level_defaults[] = { {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB , -OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC , +OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC | +OCFS2_FEATURE_INCOMPAT_INLINE_DATA ,OCFS2_FEATURE_RO_COMPAT_UNWRITTEN },/* OCFS2_FEATURE_LEVEL_DEFAULT */ {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB ,mkfs.ocfs2/mkfs.ocfs2.8.in +1
-1@@ -153,7 +153,7 @@ Chooses fewer features but ensures that the file system can be mounted from olde .RS 1.2i .TP \fBdefault\fR -The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. +The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR, \fBunwritten\fR and \fBinline-data\fR. .RE .RS 1.2i .TP
PATCH 2/2 features: Make inline-data a default feature
aah... sob.
Quoted 62 lines · Tao Ma
Signed-off-by Tao Ma <[email protected]>Quoted 44 lines · Mark Fasheh
Quoted 5 lines · Mark Fasheh
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
Signed-off-by Mark Fasheh <[email protected]>Whoops, forgot to add inline-data to the list of default features in the mkfs.ocfs2 man page... Updated patch attached.
--MarkFrom: Mark Fasheh <[email protected]>
[PATCH 2/2] features: Make inline-data a default feature
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
Signed-off-by Mark Fasheh <[email protected]>--- libocfs2/feature_string.c | 3 ++- mkfs.ocfs2/mkfs.ocfs2.8.in | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-)libocfs2/feature_string.c +2
-1@@ -62,7 +62,8 @@ static struct feature_level_translation ocfs2_feature_levels_table[] = {static ocfs2_fs_options feature_level_defaults[] = { {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB , -OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC , +OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC | +OCFS2_FEATURE_INCOMPAT_INLINE_DATA ,OCFS2_FEATURE_RO_COMPAT_UNWRITTEN },/* OCFS2_FEATURE_LEVEL_DEFAULT */ {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB ,mkfs.ocfs2/mkfs.ocfs2.8.in +0
-0mkfs.ocfs2/mkfs.ocfs2.8.in Chooses fewer features but ensures that the file system can be mounted from olde · line 159
Quoted 8 lines
mkfs.ocfs2/mkfs.ocfs2.8.in +1
-1@@ -153,7 +153,7 @@ Chooses fewer features but ensures that the file system can be mounted from olde .RS 1.2i .TP \fBdefault\fR -The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. +The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR, \fBunwritten\fR and \fBinline-data\fR. .RE .RS 1.2i .TP_______________________________________________
Ocfs2-devel mailing list
Ocfs2-devel at oss.oracle.com
http://oss.oracle.com/mailman/listinfo/ocfs2-devel
PATCH 2/2 features: Make inline-data a default feature
In reply to Mark Fashehsob
man page will need tweaking. ;) I can handle that later.
Quoted 23 lines · Mark Fasheh
Kernels since 2.6.24 have supported this, I think it's time to make it a default feature.
Signed-off-by Mark Fasheh <[email protected]>--- libocfs2/feature_string.c | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-)libocfs2/feature_string.c +2
-1@@ -62,7 +62,8 @@ static struct feature_level_translation ocfs2_feature_levels_table[] = {static ocfs2_fs_options feature_level_defaults[] = { {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB , -OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC , +OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC | +OCFS2_FEATURE_INCOMPAT_INLINE_DATA ,OCFS2_FEATURE_RO_COMPAT_UNWRITTEN },/* OCFS2_FEATURE_LEVEL_DEFAULT */ {OCFS2_FEATURE_COMPAT_BACKUP_SB |OCFS2_FEATURE_COMPAT_JBD2_SB ,
PATCH 1/2 mkfs.ocfs2: Update fs-features list in man page
In reply to Mark FashehQuoted 92 lines · Mark Fasheh
The list of available options for the fs-features flag in mkfs.ocfs2.8 was out-dated. Update the list by added information on the 'backup-super', 'inline-data' and 'extended-slotmap' options. Also, update the reported list of set features for the --fs-feature-level=default option.
At the same time, we remove the even more out of date list from the tunefs.ocfs2 man page and provide a pointer to the mkfs.ocfs2 man page. This way we only have one place to update.
Signed-off-by Mark Fasheh <[email protected]>--- mkfs.ocfs2/mkfs.ocfs2.8.in | 17 ++++++++++++++++- tunefs.ocfs2/tunefs.ocfs2.8.in | 24 +----------------------- 2 files changed, 17 insertions(+), 24 deletions(-)mkfs.ocfs2/mkfs.ocfs2.8.in +16
-1@@ -108,6 +108,11 @@ Turn specific file system features on or off. A comma separated list of feature The following flags are supported: .RS 1.2i .TP +\fBbackup-super\fR +When this is set, mkfs.ocfs2 will store a copy of the super block in several known locations so that it can be used for disaster recovery. This feature is fully compatible with all versions of Ocfs2 and generally shouldn't be disabled. +.RE +.RS 1.2i +.TP \fBlocal\fR Create the file system as a local mount, so that it can be mounted without a cluster stack. Available with the file system bundled with Linux kernels 2.6.20 and later. .RE@@ -126,6 +131,16 @@ Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (an \fBunwritten\fR Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. .RE +.RS 1.2i +.TP +\fBinline-data\fR +Enable inline-data support. If this feature is turned on, Ocfs2 will store small amounts of file and directory data inside of the inode block. Data is transparently moved out to an extent when it no longer fits inside the inode block. In some cases, this can also make a positive impact on cold-cache directory and file operations. +.RE +.RS 1.2i +.TP +\fBextended-slotmap\fR +The slot-map is a hidden file on an Ocfs2 fs which is used to map mounted nodes to system file resources. The extended slot map allows a larger range of possible node numbers, which is useful for userspace cluster stacks. This feature is automatically turned on when needed, thus users have no need to turn this on manually. +.RE .TP \fB\-\-fs\-feature\-level=\fR\fR\fIfeature\-level\fR@@ -138,7 +153,7 @@ Chooses fewer features but ensures that the file system can be mounted from olde .RS 1.2i .TP \fBdefault\fR -The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR. +The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. .RE .RS 1.2i .TPtunefs.ocfs2/tunefs.ocfs2.8.in +1
-23@@ -13,29 +13,7 @@ This tool requires the \fIO2CB\fR cluster to be online. .SH "OPTIONS" .TP \fB\-\-fs\-features=\fR\fR\fI[no]sparse...\fR -Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. -The following features are supported: -.RS 1.2i -.TP -\fBsparse\fR -Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (and zeroing) data to fill holes. Available with the file system bundled with Linux kernels 2.6.22 and later. -.RE -.RS 1.2i -.TP -\fBunwritten\fR -Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. -.RE - -.TP -\fB\-J, \-\-journal\-options\fR \fIoptions\fR -Modify the journal using options specified on the command\-line. -Journal options are comma separated, and may take an argument using -the equals ('=') sign. The following options are supported: -.RS 1.2i -.TP -\fBsize\fR=\fIjournal\-size\fR -Grow the size of journal files for all the slots. Minimum size is 4M. -.RE +Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. For a list of feature names, see the man page for \fBmkfs.ocfs2\fR. .TP \fB\-L, \-\-label\fR \fIvolume\-label\fR
PATCH 1/2 mkfs.ocfs2: Update fs-features list in man page
In reply to Mark FashehComments inlined.
Quoted 20 lines · Mark Fasheh
The list of available options for the fs-features flag in mkfs.ocfs2.8 was out-dated. Update the list by added information on the 'backup-super', 'inline-data' and 'extended-slotmap' options. Also, update the reported list of set features for the --fs-feature-level=default option.
At the same time, we remove the even more out of date list from the tunefs.ocfs2 man page and provide a pointer to the mkfs.ocfs2 man page. This way we only have one place to update.
Signed-off-by Mark Fasheh <[email protected]>--- mkfs.ocfs2/mkfs.ocfs2.8.in | 17 ++++++++++++++++- tunefs.ocfs2/tunefs.ocfs2.8.in | 24 +----------------------- 2 files changed, 17 insertions(+), 24 deletions(-)mkfs.ocfs2/mkfs.ocfs2.8.in +0
-0
mkfs.ocfs2/mkfs.ocfs2.8.in Turn specific file system features on or off. A comma separated list of feature · line 112
Quoted 5 lines
mkfs.ocfs2/mkfs.ocfs2.8.in +2
-0@@ -108,6 +108,11 @@ Turn specific file system features on or off. A comma separated list of feature The following flags are supported: .RS 1.2i .TP +\fBbackup-super\fR +When this is set, mkfs.ocfs2 will store a copy of the super block in several known locations so that it can be used for disaster recovery. This feature is fully compatible with all versions of Ocfs2 and generally shouldn't be disabled.
backup-super already exists below local. And then there is --no-backup-super.
All with different wording. How about we remove the other two and tweak the wording as follows:
\fBmkfs.ocfs2\fR, by default, makes upto 6 backup copies of the super block at offsets 1G, 4G, 16G, 64G, 256G and 1T depending on the size of the volume.
This can be useful in disaster recovery. This feature is fully compatible with all versions of the file system and generally should not be disabled.
Quoted 7 lines
mkfs.ocfs2/mkfs.ocfs2.8.in +3
-0+.RE +.RS 1.2i +.TP \fBlocal\fR Create the file system as a local mount, so that it can be mounted without a cluster stack. Available with the file system bundled with Linux kernels 2.6.20 and later. .RE
mkfs.ocfs2/mkfs.ocfs2.8.in Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (an · line 137
Quoted 7 lines
mkfs.ocfs2/mkfs.ocfs2.8.in +4
-0@@ -126,6 +131,16 @@ Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (an \fBunwritten\fR Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. .RE +.RS 1.2i +.TP +\fBinline-data\fR +Enable inline-data support. If this feature is turned on, Ocfs2 will store small amounts of file and directory data inside of the inode block. Data is transparently moved out to an extent when it no longer fits inside the inode block. In some cases, this can also make a positive impact on cold-cache directory and file operations.
Enable inline-data support. If this feature is turned on, /fIOCFS2/fR will store small files and directories inside the inode block. Data is transparently moved out to an extent when it no longer fits inside the inode block. In some cases, this can also make a positive impact on cold-cache directory and file operations. Available with the file system bundled with Linux kernels 2.6.24 and later.
mkfs.ocfs2/mkfs.ocfs2.8.in Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (an · line 143
Quoted 6 lines
mkfs.ocfs2/mkfs.ocfs2.8.in +6
-0+.RE +.RS 1.2i +.TP +\fBextended-slotmap\fR +The slot-map is a hidden file on an Ocfs2 fs which is used to map mounted nodes to system file resources. The extended slot map allows a larger range of possible node numbers, which is useful for userspace cluster stacks. This feature is automatically turned on when needed, thus users have no need to turn this on manually. +.RE
Change Ocfs2 to \fIOCFS2\fR. Also append:
Available with the file system bundled with Linux kernels 2.6.27 and later.
Quoted 37 lines
mkfs.ocfs2/mkfs.ocfs2.8.in +1
-1.TP \fB\-\-fs\-feature\-level=\fR\fR\fIfeature\-level\fR@@ -138,7 +153,7 @@ Chooses fewer features but ensures that the file system can be mounted from olde .RS 1.2i .TP \fBdefault\fR -The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR. +The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. .RE .RS 1.2i .TPtunefs.ocfs2/tunefs.ocfs2.8.in +0
-17@@ -13,29 +13,7 @@ This tool requires the \fIO2CB\fR cluster to be online. .SH "OPTIONS" .TP \fB\-\-fs\-features=\fR\fR\fI[no]sparse...\fR -Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. -The following features are supported: -.RS 1.2i -.TP -\fBsparse\fR -Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (and zeroing) data to fill holes. Available with the file system bundled with Linux kernels 2.6.22 and later. -.RE -.RS 1.2i -.TP -\fBunwritten\fR -Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. -.RE - -.TP -\fB\-J, \-\-journal\-options\fR \fIoptions\fR -Modify the journal using options specified on the command\-line. -Journal options are comma separated, and may take an argument using
tunefs.ocfs2/tunefs.ocfs2.8.in This tool requires the \fIO2CB\fR cluster to be online. · line 19
Quoted 10 lines
tunefs.ocfs2/tunefs.ocfs2.8.in +1
-6-the equals ('=') sign. The following options are supported: -.RS 1.2i -.TP -\fBsize\fR=\fIjournal\-size\fR -Grow the size of journal files for all the slots. Minimum size is 4M. -.RE +Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. For a list of feature names, see the man page for \fBmkfs.ocfs2\fR. .TP \fB\-L, \-\-label\fR \fIvolume\-label\fR
--journal-option is not a fs-feature per se. We should leave it as is. Rest is ok.
PATCH 1/2 mkfs.ocfs2: Update fs-features list in man page
Quoted 40 lines · Sunil Mushran
Comments inlined.
Quoted 23 lines · Mark Fasheh
The list of available options for the fs-features flag in mkfs.ocfs2.8 was out-dated. Update the list by added information on the 'backup-super', 'inline-data' and 'extended-slotmap' options. Also, update the reported list
of set features for the --fs-feature-level=default option.At the same time, we remove the even more out of date list from the tunefs.ocfs2 man page and provide a pointer to the mkfs.ocfs2 man page. This
way we only have one place to update.Signed-off-by Mark Fasheh <[email protected]>---
mkfs.ocfs2/mkfs.ocfs2.8.in | 17 ++++++++++++++++- tunefs.ocfs2/tunefs.ocfs2.8.in | 24 +----------------------- 2 files changed, 17 insertions(+), 24 deletions(-)mkfs.ocfs2/mkfs.ocfs2.8.in +0
-0@@ -108,6 +108,11 @@ Turn specific file system features on or off. A commaseparated list of feature
Quoted 8 lines
The following flags are supported:
.RS 1.2i
.TP
+\fBbackup-super\fR
+When this is set, mkfs.ocfs2 will store a copy of the super block in several known locations so that it can be used for disaster recovery. This feature is fully compatible with all versions of Ocfs2 and generally shouldn't be disabled.backup-super already exists below local. And then there is --no-backup-super.
All with different wording. How about we remove the other two and tweak the wording as follows:
Quoted 5 lines
\fBmkfs.ocfs2\fR, by default, makes upto 6 backup copies of the super block at offsets 1G, 4G, 16G, 64G, 256G and 1T depending on the size of the volume.
This can be useful in disaster recovery. This feature is fully compatible with all versions of the file system and generally should not be disabled.
Sounds good. I left the last one '--no-backup-super' there and marked it deprecated though. I figure it's best to keep it documented until we remove it from mkfs.ocfs2 altogether.
Quoted 10 lines
Enable inline-data support. If this feature is turned on, /fIOCFS2/fR will store small files and directories inside the inode block. Data is transparently moved out to an extent when it no longer fits inside the inode block. In some cases, this can also make a positive impact on cold-cache directory and file operations. Available with the file system bundled with Linux kernels 2.6.24 and later.
Change Ocfs2 to \fIOCFS2\fR. Also append:
Available with the file system bundled with Linux kernels 2.6.27 and later.
Done, though I'm starting to wonder about us versioning the features like that. A lot of distro kernels will have these features applied even though the actual version number is lower.
Quoted 68 lines
Quoted 68 lines
.TP \fB\-\-fs\-feature\-level=\fR\fR\fIfeature\-level\fR
mkfs.ocfs2/mkfs.ocfs2.8.in +0
-0@@ -138,7 +153,7 @@ Chooses fewer features but ensures that the filesystem can be mounted from olde
.RS 1.2i
.TP
\fBdefault\fR
-The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR.
+The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. .RE
.RS 1.2i
.TPtunefs.ocfs2/tunefs.ocfs2.8.in +0
-0@@ -13,29 +13,7 @@ This tool requires the \fIO2CB\fR cluster to be online..SH "OPTIONS"
.TP
\fB\-\-fs\-features=\fR\fR\fI[no]sparse...\fR
-Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name.tunefs.ocfs2/tunefs.ocfs2.8.in +0
-5-The following features are supported: -.RS 1.2i -.TP -\fBsparse\fR -Enable support for sparse files. With this, \fIOCFS2\fR can avoidallocating (and zeroing) data to fill holes. Available with the file system bundled with Linux kernels 2.6.22 and later.
-.RE
-.RS 1.2i
-.TP
-\fBunwritten\fR
-Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later.
-.REtunefs.ocfs2/tunefs.ocfs2.8.in +1
-11- -.TP -\fB\-J, \-\-journal\-options\fR \fIoptions\fR -Modify the journal using options specified on the command\-line. -Journal options are comma separated, and may take an argument using -the equals ('=') sign. The following options are supported: -.RS 1.2i -.TP -\fBsize\fR=\fIjournal\-size\fR -Grow the size of journal files for all the slots. Minimum size is 4M. -.RE +Turn specific file system features on or off. \fItunefs.ocfs2\fR willattempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. For a list of feature names, see the man page for \fBmkfs.ocfs2\fR.
Quoted 5 lines
Quoted 2 lines
.TP
\fB\-L, \-\-label\fR \fIvolume\-label\fR--journal-option is not a fs-feature per se. We should leave it as is. Rest is ok.
Erm, and then we'll be left with the same situation as --fs-features where one gets updated and the other doesn't, etc... I think what *was* a mistake was me not putting a pointer to mkfs.ocfs2.8 for --journal-options...
--Mark
--
Mark Fasheh
From: Mark Fasheh <[email protected]>
mkfs.ocfs2: Update fs-features list in man page
The list of available options for the fs-features flag in mkfs.ocfs2.8 was out-dated. Update the list by added information on the 'backup-super', 'inline-data' and 'extended-slotmap' options. Also, update the reported list of set features for the --fs-feature-level=default option.
At the same time, we remove the even more out of date list from the tunefs.ocfs2 man page and provide a pointer to the mkfs.ocfs2 man page. This way we only have one place to update.
--- mkfs.ocfs2/mkfs.ocfs2.8.in | 26 +++++++++++++++++--------- tunefs.ocfs2/tunefs.ocfs2.8.in | 22 ++-------------------- 2 files changed, 19 insertions(+), 29 deletions(-)
mkfs.ocfs2/mkfs.ocfs2.8.in +17 -9
@@ -2,7 +2,7 @@ .SH "NAME" mkfs.ocfs2 \- Creates an \fIOCFS2\fR file system. .SH "SYNOPSIS" -\fBmkfs.ocfs2\fR [\fB\-b\fR \fIblock\-size\fR] [\fB\-C\fR \fIcluster\-size\fR] [\fB\-L\fR \fIvolume\-label\fR] [\fB\-M\fR \fImount-type\fR] [\fB\-N\fR \fInumber\-of\-nodes\fR] [\fB\-J\fR \fIjournal\-options\fR] [\fB\-\-fs\-features=\fR\fI[no]sparse...\fR] [\fB\-\-fs\-feature\-level=\fR\fIfeature\-level\fR] [\fB\-T\fR \fIfilesystem\-type\fR] [\fB\-FqvV\fR] [\fB\-\-no\-backup\-super\fR] \fIdevice\fR [\fIblocks-count\fI] +\fBmkfs.ocfs2\fR [\fB\-b\fR \fIblock\-size\fR] [\fB\-C\fR \fIcluster\-size\fR] [\fB\-L\fR \fIvolume\-label\fR] [\fB\-M\fR \fImount-type\fR] [\fB\-N\fR \fInumber\-of\-nodes\fR] [\fB\-J\fR \fIjournal\-options\fR] [\fB\-\-fs\-features=\fR\fI[no]sparse...\fR] [\fB\-\-fs\-feature\-level=\fR\fIfeature\-level\fR] [\fB\-T\fR \fIfilesystem\-type\fR] [\fB\-FqvV\fR] \fIdevice\fR [\fIblocks-count\fI] .SH "DESCRIPTION" .PP \fBmkfs.ocfs2\fR is used to create an \fIOCFS2\fR file system on a \fIdevice\fR,
@@ -108,13 +108,13 @@ Turn specific file system features on or off. A comma separated list of feature The following flags are supported: .RS 1.2i .TP -\fBlocal\fR -Create the file system as a local mount, so that it can be mounted without a cluster stack. Available with the file system bundled with Linux kernels 2.6.20 and later. +\fBbackup-super\fR +\fBmkfs.ocfs2\fR, by default, makes up to 6 backup copies of the super block at offsets 1G, 4G, 16G, 64G, 256G and 1T depending on the size of the volume. This can be useful in disaster recovery. This feature is fully compatible with all versions of the file system and generally should not be disabled. .RE .RS 1.2i .TP -\fBbackup-super\fR -Create backup super blocks for this volume. +\fBlocal\fR +Create the file system as a local mount, so that it can be mounted without a cluster stack. Available with the file system bundled with Linux kernels 2.6.20 and later. .RE .RS 1.2i .TP
@@ -126,6 +126,16 @@ Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (an \fBunwritten\fR Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. .RE +.RS 1.2i +.TP +\fBinline-data\fR +Enable inline-data support. If this feature is turned on, /fIOCFS2/fR will store small files and directories inside the inode block. Data is transparently moved out to an extent when it no longer fits inside the inode block. In some cases, this can also make a positive impact on cold-cache directory and file operations. Available with the file system bundled with Linux kernels 2.6.24 and later. +.RE +.RS 1.2i +.TP +\fBextended-slotmap\fR +The slot-map is a hidden file on an \fIOCFS2\fR fs which is used to map mounted nodes to system file resources. The extended slot map allows a larger range of possible node numbers, which is useful for userspace cluster stacks. This feature is automatically turned on when needed, thus users have no need to turn this on manually. Available in the file system bundled with Linux kernels 2.6.27 and later. +.RE .TP \fB\-\-fs\-feature\-level=\fR\fR\fIfeature\-level\fR
@@ -138,7 +148,7 @@ Chooses fewer features but ensures that the file system can be mounted from olde .RS 1.2i .TP \fBdefault\fR -The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR. +The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR and \fBunwritten\fR. .RE .RS 1.2i .TP
@@ -148,9 +158,7 @@ Choose the maximum amount of features available. This will typically provide the .TP \fB\-\-no-backup-super\fR -\fBmkfs.ocfs2\fR, by default, makes upto 6 backup copies of the superblock -at offsets 1G, 4G, 16G, 64G, 256G and 1T depending on the size of the volume. -Use this option to make the volume with no backup superblocks. +This option is deprecated, please use \fB--fs-features=nobackup-super\fR instead. .TP \fB\-q, \-\-quiet\fR
tunefs.ocfs2/tunefs.ocfs2.8.in +2 -20
@@ -13,29 +13,11 @@ This tool requires the \fIO2CB\fR cluster to be online. .SH "OPTIONS" .TP \fB\-\-fs\-features=\fR\fR\fI[no]sparse...\fR -Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. -The following features are supported: -.RS 1.2i -.TP -\fBsparse\fR -Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (and zeroing) data to fill holes. Available with the file system bundled with Linux kernels 2.6.22 and later. -.RE -.RS 1.2i -.TP -\fBunwritten\fR -Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on. Available with the file system bundled with Linux kernels 2.6.23 and later. -.RE +Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. For a list of feature names, see the man page for \fBmkfs.ocfs2\fR. .TP \fB\-J, \-\-journal\-options\fR \fIoptions\fR -Modify the journal using options specified on the command\-line. -Journal options are comma separated, and may take an argument using -the equals ('=') sign. The following options are supported: -.RS 1.2i -.TP -\fBsize\fR=\fIjournal\-size\fR -Grow the size of journal files for all the slots. Minimum size is 4M. -.RE +Modify the journal using options specified on the command\-line. Journal options are comma separated, and may take an argument using the equals ('=') sign. For a list of possible options, see the man page for \fBmkfs.ocfs2\fR. .TP \fB\-L, \-\-label\fR \fIvolume\-label\fR
Signature · 1 line
1.5.6
PATCH 1/2 mkfs.ocfs2: Update fs-features list in man page
Quoted 3 lines · Mark Fasheh
Sounds good. I left the last one '--no-backup-super' there and marked it deprecated though. I figure it's best to keep it documented until we remove it from mkfs.ocfs2 altogether.
ok.
Quoted 3 lines
Done, though I'm starting to wonder about us versioning the features like that. A lot of distro kernels will have these features applied even though the actual version number is lower.
By distro I am assuming you mean enterprise kernels. That is always a pain to document. I have tried to keep the tools mainline centric. Enterprise users have a user's guide as the reference.
I think this will sort itself out as ocfs2 in enterprise distros is closer to the mainline kernel.
The other option is not to mention the version. But then we hurt the non-enterprise users for whom we have no other docs.
Quoted 3 lines
Erm, and then we'll be left with the same situation as --fs-features where one gets updated and the other doesn't, etc... I think what *was* a mistake was me not putting a pointer to mkfs.ocfs2.8 for --journal-options...
Sure. That will work.