gfs2-utils: master - gfs2-utils: README file improvements
Gitweb:
http://git.fedorahosted.org/git/?p=gfs2-utils.git;a=commitdiff;h=2e0c08d5...
Commit: 2e0c08d53e44a4a053a47482e0035e42144f74bb
Parent: e3dd91be030cfb6c473e4b1cce2dc32df9e7ab4f
Author: Andrew Price <anprice(a)redhat.com>
AuthorDate: Fri Jan 20 11:39:59 2017 +0000
Committer: Andrew Price <anprice(a)redhat.com>
CommitterDate: Fri Jan 20 11:39:59 2017 +0000
gfs2-utils: README file improvements
Add some introductory text, split the info into sections, separate the
build requirements from the installation requirements and generally tidy
up.
Signed-off-by: Andrew Price <anprice(a)redhat.com>
---
README | 72 ++++++++++++++++++++++++++++++++++++++++++++-------------------
1 files changed, 50 insertions(+), 22 deletions(-)
diff --git a/README b/README
index d0a21c3..e8ab577 100644
--- a/README
+++ b/README
@@ -1,41 +1,69 @@
+gfs2-utils
+----------
-To build this source tree, you will need:
+This package contains the tools needed to create, check, manipulate and analyze
+gfs2 filesystems, along with important scripts required to support gfs2
+clusters.
- - automake
- - GNU make
- - GCC tool chain
+Build instructions
+------------------
-Plus the following libraries:
+The following development packages are required to build gfs2-utils:
- ncurses (for gfs2_edit)
- gettext
- bison
- flex
- zlib
- libblkid
- check (optional, enables the test suite)
+ o autoconf
+ o automake
+ o libtool
+ o GNU make
+ o ncurses
+ o gettext
+ o bison
+ o flex
+ o zlib
+ o libblkid
+ o check (optional, enables the test suite)
+
+The kernel header include/linux/gfs2-ondisk.h and its dependencies are also
+required.
To build gfs2-utils, run the following commands:
- ./autogen.sh
- ./configure
- make
+ $ ./autogen.sh
+ $ ./configure
+ $ make
+
+See ./configure --help for more build configuration options.
+
+Test Suite
+----------
+
+To run the test suite, use:
-To run the test suite:
+ $ make check
- make check
+See doc/README.tests for more details regarding the test suite.
+
+Installation
+------------
+
+gfs2-utils requires the following libraries:
+
+ o zlib
+ o ncurses
+ o libblkid
To install gfs2-utils, run:
- make install
+ # make install
+
+Support scripts
+---------------
The following scripts (located in gfs2/scripts) are used to complete
the userland portion of the gfs2 withdraw feature using uevents. They
will be installed by 'make install' to these directories by default:
- 82-gfs2-withdraw.rules in /usr/lib/udev/rules.d/
- gfs2_withdraw_helper in /usr/sbin/
+ 82-gfs2-withdraw.rules in /usr/lib/udev/rules.d/
+ gfs2_withdraw_helper in /usr/sbin/
-See also doc/README.contributing for details on submitting patches and
-doc/README.tests for more details regarding the test suite.
+See also doc/README.contributing for details on submitting patches.