This is the mail archive of the
cluster-cvs@sourceware.org
mailing list for the cluster.
master - config: move generic documenation and man pages to config/man
- From: "Fabio M. Di Nitto" <fabbione at fedoraproject dot org>
- To: cluster-cvs-relay at redhat dot com
- Date: Thu, 14 Aug 2008 14:26:54 +0000 (UTC)
- Subject: master - config: move generic documenation and man pages to config/man
Gitweb: http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=811543fb2e5a921e185812c22dacd5dbc0579b9a
Commit: 811543fb2e5a921e185812c22dacd5dbc0579b9a
Parent: 890badb2946d136ca4be89dd4dbdab9ce2ae8f65
Author: Fabio M. Di Nitto <fdinitto@redhat.com>
AuthorDate: Thu Aug 7 07:12:15 2008 +0200
Committer: Fabio M. Di Nitto <fdinitto@redhat.com>
CommitterDate: Thu Aug 14 15:18:02 2008 +0200
config: move generic documenation and man pages to config/man
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
---
ccs/man/ccs.7 | 22 ----------------
ccs/man/cluster.conf.5 | 61 ---------------------------------------------
config/Makefile | 2 +-
config/man/Makefile | 5 +++
config/man/ccs.7 | 22 ++++++++++++++++
config/man/cluster.conf.5 | 61 +++++++++++++++++++++++++++++++++++++++++++++
6 files changed, 89 insertions(+), 84 deletions(-)
diff --git a/ccs/man/ccs.7 b/ccs/man/ccs.7
deleted file mode 100644
index 0818bdf..0000000
--- a/ccs/man/ccs.7
+++ /dev/null
@@ -1,22 +0,0 @@
-.TH ccs 7
-
-.SH NAME
-ccs - Cluster Configuration System
-
-.SH DESCRIPTION
-
-CCS is the system that manages the /etc/cluster/cluster.conf file on
-cluster nodes. The primary users of cluster.conf are the cman cluster
-manager, the fenced fencing daemon and rgmanager which manages H/A
-services.
-
-libccs is the API used by the programs and daemons above to read
-cluster.conf information. libccs requests go through the ccsd daemon.
-ccsd needs to be started before the cman cluster manager is started.
-
-The ccs_test program can be used to test the ccs system and read
-cluster.conf values.
-
-.SH SEE ALSO
-ccsd(8), ccs_tool(8), ccs_test(8), cluster.conf(5), cman(5)
-
diff --git a/ccs/man/cluster.conf.5 b/ccs/man/cluster.conf.5
deleted file mode 100644
index b45d410..0000000
--- a/ccs/man/cluster.conf.5
+++ /dev/null
@@ -1,61 +0,0 @@
-.TH cluster.conf 5
-
-.SH NAME
-cluster.conf - configuration file for cman, fence, dlm, gfs, rgmanager
-
-.SH DESCRIPTION
-
-The \fBcluster.conf\fP file is located in the /etc/cluster directory. It
-is the source of information used by cman, fence, dlm, gfs and rgmanager.
-It's accessed indirectly through libccs (see \fBccs(7)\fP). This file
-contains all the information needed for the cluster to operate, such as
-what nodes are in the cluster and how to I/O fence those nodes.
-
-This man page describes the generic contents of the \fBcluster.conf\fP
-file. For other information see man pages for cman(5), fenced(8) and
-dlm_controld(8).
-
-\fBcluster.conf\fP is an XML file. It has one top-level \fIcluster\fP
-section containing everything else. The cluster section has two mandatory
-attributes: \fIname\fP and \fIconfig_version\fP. \fIname\fP can be up to
-16 characters long and specifies the name of the cluster. It is important
-that this name is unique from other clusters the user might set up.
-\fIconfig_version\fP is a number used to identify the revision level of
-the \fBcluster.conf\fP file. Given this information, your
-\fBcluster.conf\fP file might look something like:
-
- <cluster name="alpha" config_version="1">
- </cluster>
-
-.SS Nodes
-
-The set of nodes that make up the cluster are defined under the
-\fIclusternodes\fP section. A \fIclusternode\fP section defines each
-node. A clusternode has two mandatory attributes:
-.I name
-and
-.I nodeid
-
-The name should correspond to the hostname (the fully qualified name is
-generally not necessary) on the network interface to be used for cluster
-communication. Nodeid's must be greater than zero and unique.
-
- <cluster name="alpha" config_version="1">
- <clusternodes>
- <clusternode name="node-01" nodeid="1">
- </clusternode>
-
- <clusternode name="node-02" nodeid="2">
- </clusternode>
-
- <clusternode name="node-03" nodeid="3">
- </clusternode>
- </clusternodes>
- </cluster>
-
-The next step in completing cluster.conf is adding fencing information;
-see fenced(8).
-
-.SH SEE ALSO
-ccs(7), ccs_tool(8), ccsd(8), cman(5), fenced(8), dlm_controld(8)
-
diff --git a/config/Makefile b/config/Makefile
index 366c241..50468ed 100644
--- a/config/Makefile
+++ b/config/Makefile
@@ -1,4 +1,4 @@
include ../make/defines.mk
include $(OBJDIR)/make/passthrough.mk
-SUBDIRS=libs plugins tools
+SUBDIRS=libs plugins tools man
diff --git a/config/man/Makefile b/config/man/Makefile
new file mode 100644
index 0000000..62b2e1e
--- /dev/null
+++ b/config/man/Makefile
@@ -0,0 +1,5 @@
+TARGET= ccs.7 \
+ cluster.conf.5
+
+include ../../make/defines.mk
+include $(OBJDIR)/make/man.mk
diff --git a/config/man/ccs.7 b/config/man/ccs.7
new file mode 100644
index 0000000..0818bdf
--- /dev/null
+++ b/config/man/ccs.7
@@ -0,0 +1,22 @@
+.TH ccs 7
+
+.SH NAME
+ccs - Cluster Configuration System
+
+.SH DESCRIPTION
+
+CCS is the system that manages the /etc/cluster/cluster.conf file on
+cluster nodes. The primary users of cluster.conf are the cman cluster
+manager, the fenced fencing daemon and rgmanager which manages H/A
+services.
+
+libccs is the API used by the programs and daemons above to read
+cluster.conf information. libccs requests go through the ccsd daemon.
+ccsd needs to be started before the cman cluster manager is started.
+
+The ccs_test program can be used to test the ccs system and read
+cluster.conf values.
+
+.SH SEE ALSO
+ccsd(8), ccs_tool(8), ccs_test(8), cluster.conf(5), cman(5)
+
diff --git a/config/man/cluster.conf.5 b/config/man/cluster.conf.5
new file mode 100644
index 0000000..b45d410
--- /dev/null
+++ b/config/man/cluster.conf.5
@@ -0,0 +1,61 @@
+.TH cluster.conf 5
+
+.SH NAME
+cluster.conf - configuration file for cman, fence, dlm, gfs, rgmanager
+
+.SH DESCRIPTION
+
+The \fBcluster.conf\fP file is located in the /etc/cluster directory. It
+is the source of information used by cman, fence, dlm, gfs and rgmanager.
+It's accessed indirectly through libccs (see \fBccs(7)\fP). This file
+contains all the information needed for the cluster to operate, such as
+what nodes are in the cluster and how to I/O fence those nodes.
+
+This man page describes the generic contents of the \fBcluster.conf\fP
+file. For other information see man pages for cman(5), fenced(8) and
+dlm_controld(8).
+
+\fBcluster.conf\fP is an XML file. It has one top-level \fIcluster\fP
+section containing everything else. The cluster section has two mandatory
+attributes: \fIname\fP and \fIconfig_version\fP. \fIname\fP can be up to
+16 characters long and specifies the name of the cluster. It is important
+that this name is unique from other clusters the user might set up.
+\fIconfig_version\fP is a number used to identify the revision level of
+the \fBcluster.conf\fP file. Given this information, your
+\fBcluster.conf\fP file might look something like:
+
+ <cluster name="alpha" config_version="1">
+ </cluster>
+
+.SS Nodes
+
+The set of nodes that make up the cluster are defined under the
+\fIclusternodes\fP section. A \fIclusternode\fP section defines each
+node. A clusternode has two mandatory attributes:
+.I name
+and
+.I nodeid
+
+The name should correspond to the hostname (the fully qualified name is
+generally not necessary) on the network interface to be used for cluster
+communication. Nodeid's must be greater than zero and unique.
+
+ <cluster name="alpha" config_version="1">
+ <clusternodes>
+ <clusternode name="node-01" nodeid="1">
+ </clusternode>
+
+ <clusternode name="node-02" nodeid="2">
+ </clusternode>
+
+ <clusternode name="node-03" nodeid="3">
+ </clusternode>
+ </clusternodes>
+ </cluster>
+
+The next step in completing cluster.conf is adding fencing information;
+see fenced(8).
+
+.SH SEE ALSO
+ccs(7), ccs_tool(8), ccsd(8), cman(5), fenced(8), dlm_controld(8)
+