[06/12] contrib: add README file for items under contrib

Message ID 20111111202652.10717.82509.stgit@degas.1015granger.net
State Accepted
Headers show

Commit Message

Chuck Lever Nov. 11, 2011, 8:26 p.m.
Items under contrib are not installed automatically by our Makefiles,
but they do need at least a little documentation.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Acked-by: Jeff Layton <jlayton@redhat.com>

 contrib/init/Makefile.am |    2 +-
 contrib/init/README      |   26 ++++++++++++++++++++++++++
 2 files changed, 27 insertions(+), 1 deletions(-)
 create mode 100644 contrib/init/README


diff --git a/contrib/init/Makefile.am b/contrib/init/Makefile.am
index ef2f07b..c8740ff 100644
--- a/contrib/init/Makefile.am
+++ b/contrib/init/Makefile.am
@@ -23,7 +23,7 @@ 
 ##	http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
-EXTRA_DIST		= fedfs rpcfedfsd rpcfedfsd.service
+EXTRA_DIST		= fedfs README rpcfedfsd rpcfedfsd.service
 CLEANFILES		= cscope.in.out cscope.out cscope.po.out *~
 DISTCLEANFILES		= Makefile.in
diff --git a/contrib/init/README b/contrib/init/README
new file mode 100644
index 0000000..45ed56a
--- /dev/null
+++ b/contrib/init/README
@@ -0,0 +1,26 @@ 
+Date: Thu Nov 10 11:37:07 EST 2011
+Author: Chuck Lever <chuck.lever@oracle.com>
+Items in the contrib/init subdirectory are provided on an as-is basis as a
+courtesy.  These items are not tested as part of the fedfs-utils check-in
+or release process.  They are not installed by the fedfs-utils Makefiles,
+but must be installed as needed by hand.
+Use them at your own risk, but do report bugs to us and we will try to
+see that issues are addressed in the fedfs-utils distribution.
+Item			Purpose
+----			--------
+fedfs			Sample /etc/sysconfig/fedfs configuration file
+README			This file
+rpcfedfsd		Sample SysV start-up script for rpc.fedfsd; typically
+			installed in /etc/init.d, and then activated with the
+			equivalent of "chkconfig rpcfedfsd on"
+rpcfedfsd.service	Sample systemd service file for rpc.fedfsd; see
+			http://0pointer.de/blog/projects/systemd-for-admins-3.html
+			for further details