From 77f94c71d67ff14efd581626776ae6d7f64fc5d2 Mon Sep 17 00:00:00 2001
From: Stephen Gallagher <sgallagh@redhat.com>
Date: Nov 07 2014 18:22:35 +0000
Subject: Add some more docs


---

diff --git a/0001-docs-Updated-global-rolekit-man-page.patch b/0001-docs-Updated-global-rolekit-man-page.patch
new file mode 100644
index 0000000..89b4395
--- /dev/null
+++ b/0001-docs-Updated-global-rolekit-man-page.patch
@@ -0,0 +1,183 @@
+From 8dcab20570e1b4b97b432d1b3f908e388a6f8d2f Mon Sep 17 00:00:00 2001
+From: Thomas Woerner <twoerner@redhat.com>
+Date: Fri, 31 Oct 2014 16:36:35 +0100
+Subject: [PATCH] docs: Updated global rolekit man page.
+
+Reviewed at https://reviewboard-fedoraserver.rhcloud.com/r/111/
+---
+ doc/xml/rolekit.xml           | 98 ++++++++++++++++++++++++++++++++++++++++---
+ doc/xml/transform-html.xsl.in | 10 +++++
+ doc/xml/transform-man.xsl.in  | 10 +++++
+ 3 files changed, 113 insertions(+), 5 deletions(-)
+
+diff --git a/doc/xml/rolekit.xml b/doc/xml/rolekit.xml
+index ce3a709c84446534bac19d9ec2fce6a1133de241..1d2520bc3093a72757c5d30c0282902fceaac8d5 100644
+--- a/doc/xml/rolekit.xml
++++ b/doc/xml/rolekit.xml
+@@ -41,20 +41,108 @@
+     <manvolnum>5</manvolnum>
+   </refmeta>
+ 
+   <refnamediv>
+     <refname>rolekit</refname>
+-    <refpurpose>rolekit documentation</refpurpose>
++    <refpurpose>server role management toolkit</refpurpose>
+   </refnamediv>
+ 
+-  <refsynopsisdiv>
+-  </refsynopsisdiv>
+-
+   <refsect1 id="description">
+     <title>Description</title>
+     <para>
+-      rolekit is ...
++      rolekit is a server role deployment and management toolkit. A server role could be seen as a service or a use case that is providing several services. A deployed role is a (role) instance.
++    </para>
++    <para>
++      A plugin interface is used for simple role creation. Each role is a plugin to rolekit and can therefore be easily created. A D-Bus interface and also a command line client is available for role management.
++    </para>
++  </refsect1>
++
++  <refsect1 id="concept">
++    <title>Concept</title>
++    <para>
++      A role plugin describes the receipt to get to the configured and running role. For this a plugin provides a predefined set of methods and role settings (properties).
++    </para>
++    <para>
++      Roles are loaded from the <filename><config.rolekit_roles/></filename> directory. Each role owns a directory named after the role itself. The directory contains role.py, that is inherited from RoleBase and implementing the role.
++    </para>
++    <para>
++      Each role instance owns a sub directory in <filename><config.etc_rolekit_roles/></filename>, named after the role. The directory contains JSON settings files using the name of the instances as the filename with the JSON extension.
++    </para>
++
++    <para>
++      While deploying a role, these steps are done internally:
++
++      <orderedlist>
++        <listitem>
++	  <para>
++	    <replaceable>DBusRole.deploy</replaceable> is called.
++	    <orderedlist>
++              <listitem>
++		<para>
++		  Checks that the name is valid and that there is no conflict with another instance of that role.
++		</para>
++	      </listitem>
++
++              <listitem>
++		<para>
++		  Creates the role instance from <replaceable>RoleBase</replaceable>.
++		</para>
++	      </listitem>
++
++              <listitem>
++		<para>
++		  Calls <replaceable>RoleBase.deploy_async</replaceable> method in the instance.
++		</para>
++	      </listitem>
++
++	    </orderedlist>
++	  </para>
++	</listitem>
++
++        <listitem>
++	  <para>
++	    Checks settings supplied by the user.
++	  </para>
++	</listitem>
++
++        <listitem>
++	  <para>
++	    Sets the instance into the <replaceable>deploying</replaceable> state.
++	  </para>
++	</listitem>
++
++        <listitem>
++	  <para>
++	    Installs groups and packages defined in the packages setting.
++	  </para>
++	</listitem>
++
++        <listitem>
++	  <para>
++	    Installs firewall settings.
++	  </para>
++	</listitem>
++
++        <listitem>
++	  <para>
++	    Calls <replaceable>Role.do_deploy_async</replaceable> method.
++	  </para>
++	</listitem>
++
++        <listitem>
++	  <para>
++	    Creates the systemd target.
++	  </para>
++	</listitem>
++
++        <listitem>
++	  <para>
++	    Sets the instance into the <replaceable>ready-to-start</replaceable> state.
++	  </para>
++	</listitem>
++
++      </orderedlist>
+     </para>
+   </refsect1>
+ 
+   &seealso;
+ 
+diff --git a/doc/xml/transform-html.xsl.in b/doc/xml/transform-html.xsl.in
+index 18cb861598bc59d35efbe479f5578bf2eec36d76..1438ae81569594c4dade437fd725fd0195459007 100644
+--- a/doc/xml/transform-html.xsl.in
++++ b/doc/xml/transform-html.xsl.in
+@@ -12,10 +12,20 @@
+   <!-- prefix -->
+   <xsl:template match="config.prefix">
+     <xsl:text>@PREFIX@</xsl:text>
+   </xsl:template>
+ 
++  <!-- etc_rolekit_roles -->
++  <xsl:template match="config.etc_rolekit_roles">
++    <xsl:text>@SYSCONFDIR@/rolekit/roles</xsl:text>
++  </xsl:template>
++
++  <!-- rolekit_roles -->
++  <xsl:template match="config.rolekit_roles">
++    <xsl:text>@PREFIX@/rolekit/roles</xsl:text>
++  </xsl:template>
++
+   <!-- generate URL for citerefentry for rolekit* references only -->
+   <xsl:template match="citerefentry">
+     <xsl:choose>
+       <xsl:when test="starts-with(refentrytitle, 'rolekit')">
+ 	<a>
+diff --git a/doc/xml/transform-man.xsl.in b/doc/xml/transform-man.xsl.in
+index 066644b61861a39e22eb7807e26417392eac2c8c..778d0d0b31b687d4d2de7ef51e3e5bdc0335df32 100644
+--- a/doc/xml/transform-man.xsl.in
++++ b/doc/xml/transform-man.xsl.in
+@@ -23,10 +23,20 @@
+   <!-- prefix -->
+   <xsl:template match="config.prefix">
+     <xsl:text>@PREFIX@</xsl:text>
+   </xsl:template>
+ 
++  <!-- etc_rolekit_roles -->
++  <xsl:template match="config.etc_rolekit_roles">
++    <xsl:text>@SYSCONFDIR@/rolekit/roles</xsl:text>
++  </xsl:template>
++
++  <!-- rolekit_roles -->
++  <xsl:template match="config.rolekit_roles">
++    <xsl:text>@PREFIX@/rolekit/roles</xsl:text>
++  </xsl:template>
++
+   <!-- italic filenames -->
+   <xsl:template match="//filename">
+     <xsl:text>\fI</xsl:text><xsl:apply-templates/><xsl:text>\fR</xsl:text>
+   </xsl:template>
+ 
+-- 
+2.1.0
+
diff --git a/rolekit.spec b/rolekit.spec
index 93b350d..1740d6c 100644
--- a/rolekit.spec
+++ b/rolekit.spec
@@ -1,7 +1,7 @@
 Summary: A server daemon with D-Bus interface providing a server roles
 Name: rolekit
 Version: 0.1.1
-Release: 1%{?dist}
+Release: 2%{?dist}
 URL: http://fedorahosted.org/rolekit
 License: GPLv2+
 Source0: https://fedorahosted.org/released/rolekit/%{name}-%{version}.tar.bz2
@@ -27,12 +27,14 @@ Requires(preun): systemd
 Requires(postun): systemd
 
 # Patches
+Patch0001: 0001-docs-Updated-global-rolekit-man-page.patch
 
 %description
 rolekit is a server daemon that provides a D-Bus interface and server roles.
 
 %prep
 %setup -q
+%patch0001 -p1
 
 %build
 %configure
@@ -95,6 +97,9 @@ make install DESTDIR=%{buildroot}
 
 
 %changelog
+* Fri Nov 07 2014 Stephen Gallagher <sgallagh@redhat.com> 0.1.1-2
+- Add some more docs
+
 * Thu Nov 06 2014 Stephen Gallagher <sgallagh@redhat.com> 0.1.1-1
 - Improved documentation
 - Added bash-completion support for rolectl