* [PATCH] erofs-utils: add manual for mkfs.erofs
[not found] <20191103153055.11471-1-hsiangkao.ref@aol.com>
@ 2019-11-03 15:30 ` Gao Xiang via Linux-erofs
2019-11-04 7:28 ` [PATCH v2] " Gao Xiang via Linux-erofs
0 siblings, 1 reply; 3+ messages in thread
From: Gao Xiang via Linux-erofs @ 2019-11-03 15:30 UTC (permalink / raw)
To: Li Guifu, linux-erofs; +Cc: Miao Xie
This patch adds mkfs.erofs manpage, which is a requirement of a
debian binary package (See Debian Policy Manual section 12.1 [1].)
[1] https://www.debian.org/doc/debian-policy/ch-docs.html#manual-pages
Signed-off-by: Gao Xiang <hsiangkao@aol.com>
---
Makefile.am | 2 +-
configure.ac | 1 +
man/Makefile.am | 5 ++++
man/mkfs.erofs.1 | 68 ++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 75 insertions(+), 1 deletion(-)
create mode 100644 man/Makefile.am
create mode 100644 man/mkfs.erofs.1
diff --git a/Makefile.am b/Makefile.am
index d94ab73..1d20577 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -3,4 +3,4 @@
ACLOCAL_AMFLAGS = -I m4
-SUBDIRS=lib mkfs
+SUBDIRS = man lib mkfs
diff --git a/configure.ac b/configure.ac
index 4f88678..a93767f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -173,6 +173,7 @@ AM_CONDITIONAL([ENABLE_LZ4], [test "x${have_lz4}" = "xyes"])
AM_CONDITIONAL([ENABLE_LZ4HC], [test "x${have_lz4hc}" = "xyes"])
AC_CONFIG_FILES([Makefile
+ man/Makefile
lib/Makefile
mkfs/Makefile])
AC_OUTPUT
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..dcdbb35
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: GPL-2.0+
+# Makefile.am
+
+dist_man_MANS = mkfs.erofs.1
+
diff --git a/man/mkfs.erofs.1 b/man/mkfs.erofs.1
new file mode 100644
index 0000000..7fb1464
--- /dev/null
+++ b/man/mkfs.erofs.1
@@ -0,0 +1,68 @@
+.\" Copyright (c) 2019 Gao Xiang <xiang@kernel.org>
+.\"
+.TH MKFS.EROFS 1
+.SH NAME
+mkfs.erofs \- tool to create an EROFS filesystem
+.SH SYNOPSIS
+\fBmkfs.erofs\fR [\fIOPTIONS\fR] \fIDESTINATION\fR \fISOURCE\fR
+.SH DESCRIPTION
+EROFS is a new enhanced lightweight linux read-only filesystem with modern
+designs (eg. no buffer head, reduced metadata, inline xattrs/data, etc.) for
+scenarios which need high-performance read-only requirements, e.g. Android OS
+for smartphones and LIVECDs.
+.PP
+It also provides fixed-sized output compression support, which improves storage
+density, keeps relatively higher compression ratios, which is more useful to
+achieve high performance for embedded devices with limited memory since it has
+unnoticable memory overhead and page cache thrashing.
+.PP
+mkfs.erofs is used to create such EROFS filesystem \fIDESTINATION\fR image file
+from \fISOURCE\fR directory.
+.SH OPTIONS
+.TP
+.BI "\-z " compression-algorithm " [" ",#" "]"
+Set an algorithm for file compression, which can be set with an optional
+compression level separated by a comma.
+.TP
+.BI "\-d " #
+Specify the level of debugging messages. The default is 0.
+.TP
+.BI "\-x " #
+Specify the upper limit of an xattr which is still inlined. The default is 2.
+Disable storing xattrs if < 0.
+.TP
+.BI "\-E " extended-option " [,...]"
+Set extended options for the filesystem. Extended options are comma separated,
+and may take an argument using the equals ('=') sign.
+The following extended options are supported:
+.RS 1.2i
+.TP
+.BI legacy-compress
+Disable "decompression in-place" and "compacted indexes" support, which is used
+when generating EROFS images for kernel version < 5.3.
+.TP
+.BI force-inode-compact
+Forcely generate compact inodes (32-byte inodes) to output.
+.TP
+.BI force-inode-extended
+Forcely generate extended inodes (64-byte inodes) to output.
+.RE
+.TP
+.BI "\-T " #
+Set all files to this given UNIX timestamp. Reproducible builds requires setting
+all to a specific one.
+.TP
+.B \-\-help
+Display this help and exit.
+.SH AUTHOR
+This version of \fBmkfs.erofs\fR is written by Li Guifu <blucerlee@gmail.com>,
+Miao Xie <miaoxie@huawei.com> and Gao Xiang <xiang@kernel.org> with
+continuously improvements from others.
+.PP
+This manual page was written by Gao Xiang <xiang@kernel.org>.
+.SH AVAILABILITY
+\fBmkfs.erofs\fR is part of erofs-utils package and is available from
+git://git.kernel.org/pub/scm/linux/kernel/git/xiang/erofs-utils.git.
+.SH SEE ALSO
+.BR mkfs (8).
+
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH v2] erofs-utils: add manual for mkfs.erofs
2019-11-03 15:30 ` [PATCH] erofs-utils: add manual for mkfs.erofs Gao Xiang via Linux-erofs
@ 2019-11-04 7:28 ` Gao Xiang via Linux-erofs
2019-11-04 16:40 ` Li Guifu
0 siblings, 1 reply; 3+ messages in thread
From: Gao Xiang via Linux-erofs @ 2019-11-04 7:28 UTC (permalink / raw)
To: Li Guifu, linux-erofs; +Cc: Miao Xie
This patch adds mkfs.erofs manpage, which is a requirement of
a debian binary package (See Debian Policy Manual section 12.1 [1].)
[1] https://www.debian.org/doc/debian-policy/ch-docs.html#manual-pages
Signed-off-by: Gao Xiang <hsiangkao@aol.com>
---
changes since v1:
- remove redundant whitespace in the previous version;
- adjust long lines.
Makefile.am | 2 +-
configure.ac | 1 +
man/Makefile.am | 5 ++++
man/mkfs.erofs.1 | 68 ++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 75 insertions(+), 1 deletion(-)
create mode 100644 man/Makefile.am
create mode 100644 man/mkfs.erofs.1
diff --git a/Makefile.am b/Makefile.am
index d94ab73..1d20577 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -3,4 +3,4 @@
ACLOCAL_AMFLAGS = -I m4
-SUBDIRS=lib mkfs
+SUBDIRS = man lib mkfs
diff --git a/configure.ac b/configure.ac
index 4f88678..a93767f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -173,6 +173,7 @@ AM_CONDITIONAL([ENABLE_LZ4], [test "x${have_lz4}" = "xyes"])
AM_CONDITIONAL([ENABLE_LZ4HC], [test "x${have_lz4hc}" = "xyes"])
AC_CONFIG_FILES([Makefile
+ man/Makefile
lib/Makefile
mkfs/Makefile])
AC_OUTPUT
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..dcdbb35
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: GPL-2.0+
+# Makefile.am
+
+dist_man_MANS = mkfs.erofs.1
+
diff --git a/man/mkfs.erofs.1 b/man/mkfs.erofs.1
new file mode 100644
index 0000000..d6bf828
--- /dev/null
+++ b/man/mkfs.erofs.1
@@ -0,0 +1,68 @@
+.\" Copyright (c) 2019 Gao Xiang <xiang@kernel.org>
+.\"
+.TH MKFS.EROFS 1
+.SH NAME
+mkfs.erofs \- tool to create an EROFS filesystem
+.SH SYNOPSIS
+\fBmkfs.erofs\fR [\fIOPTIONS\fR] \fIDESTINATION\fR \fISOURCE\fR
+.SH DESCRIPTION
+EROFS is a new enhanced lightweight linux read-only filesystem with modern
+designs (eg. no buffer head, reduced metadata, inline xattrs/data, etc.) for
+scenarios which need high-performance read-only requirements, e.g. Android OS
+for smartphones and LIVECDs.
+.PP
+It also provides fixed-sized output compression support, which improves storage
+density, keeps relatively higher compression ratios, which is more useful to
+achieve high performance for embedded devices with limited memory since it has
+unnoticable memory overhead and page cache thrashing.
+.PP
+mkfs.erofs is used to create such EROFS filesystem \fIDESTINATION\fR image file
+from \fISOURCE\fR directory.
+.SH OPTIONS
+.TP
+.BI "\-z " compression-algorithm " [" ",#" "]"
+Set an algorithm for file compression, which can be set with an optional
+compression level separated by a comma.
+.TP
+.BI "\-d " #
+Specify the level of debugging messages. The default is 0.
+.TP
+.BI "\-x " #
+Specify the upper limit of an xattr which is still inlined. The default is 2.
+Disable storing xattrs if < 0.
+.TP
+.BI "\-E " extended-option " [,...]"
+Set extended options for the filesystem. Extended options are comma separated,
+and may take an argument using the equals ('=') sign.
+The following extended options are supported:
+.RS 1.2i
+.TP
+.BI legacy-compress
+Disable "decompression in-place" and "compacted indexes" support, which is used
+when generating EROFS images for kernel version < 5.3.
+.TP
+.BI force-inode-compact
+Forcely generate compact inodes (32-byte inodes) to output.
+.TP
+.BI force-inode-extended
+Forcely generate extended inodes (64-byte inodes) to output.
+.RE
+.TP
+.BI "\-T " #
+Set all files to the given UNIX timestamp. Reproducible builds requires setting
+all to a specific one.
+.TP
+.B \-\-help
+Display this help and exit.
+.SH AUTHOR
+This version of \fBmkfs.erofs\fR is written by Li Guifu <blucerlee@gmail.com>,
+Miao Xie <miaoxie@huawei.com> and Gao Xiang <xiang@kernel.org> with
+continuously improvements from others.
+.PP
+This manual page was written by Gao Xiang <xiang@kernel.org>.
+.SH AVAILABILITY
+\fBmkfs.erofs\fR is part of erofs-utils package and is available from
+git://git.kernel.org/pub/scm/linux/kernel/git/xiang/erofs-utils.git.
+.SH SEE ALSO
+.BR mkfs (8).
+
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] erofs-utils: add manual for mkfs.erofs
2019-11-04 7:28 ` [PATCH v2] " Gao Xiang via Linux-erofs
@ 2019-11-04 16:40 ` Li Guifu
0 siblings, 0 replies; 3+ messages in thread
From: Li Guifu @ 2019-11-04 16:40 UTC (permalink / raw)
To: Gao Xiang, Li Guifu, linux-erofs; +Cc: Miao Xie
On 2019/11/4 15:28, Gao Xiang wrote:
> This patch adds mkfs.erofs manpage, which is a requirement of
> a debian binary package (See Debian Policy Manual section 12.1 [1].)
>
> [1] https://www.debian.org/doc/debian-policy/ch-docs.html#manual-pages
> Signed-off-by: Gao Xiang <hsiangkao@aol.com>
> ---
It looks good
Reviewed-by: Li Guifu <blucerlee@gmail.com>
Tested-by: Li Guifu <blucerlee@gmail.com>
Thanks,
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-11-04 16:49 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <20191103153055.11471-1-hsiangkao.ref@aol.com>
2019-11-03 15:30 ` [PATCH] erofs-utils: add manual for mkfs.erofs Gao Xiang via Linux-erofs
2019-11-04 7:28 ` [PATCH v2] " Gao Xiang via Linux-erofs
2019-11-04 16:40 ` Li Guifu
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).