resource-agents: master - resource-agents: Add missing resource docs

Marek Grác marx at fedoraproject.org
Sat Oct 16 13:54:42 UTC 2010


Gitweb:        http://git.fedorahosted.org/git/resource-agents.git?p=resource-agents.git;a=commitdiff;h=2b4c9febfc18492625d0f170ab6dabb5e2e96e4f
Commit:        2b4c9febfc18492625d0f170ab6dabb5e2e96e4f
Parent:        3dcf9c617b4cda3e3cac02312314bc90ff856a6c
Author:        Lon Hohberger <lhh at redhat.com>
AuthorDate:    Tue Jun 15 15:44:23 2010 -0400
Committer:     Marek 'marx' Grac <mgrac at redhat.com>
CommitterDate: Sat Oct 16 15:28:58 2010 +0200

resource-agents: Add missing resource docs

Resolves: rhbz#606470

Signed-off-by: Lon Hohberger <lhh at redhat.com>
---
 rgmanager/src/resources/ra2rng.xsl         |   17 ++++++++---------
 rgmanager/src/resources/resources.rng.tail |   10 +++++-----
 2 files changed, 13 insertions(+), 14 deletions(-)

diff --git a/rgmanager/src/resources/ra2rng.xsl b/rgmanager/src/resources/ra2rng.xsl
index af65ee9..425faa9 100644
--- a/rgmanager/src/resources/ra2rng.xsl
+++ b/rgmanager/src/resources/ra2rng.xsl
@@ -8,36 +8,35 @@
 
 <xsl:template match="/resource-agent">
   &lt;define name="<xsl:call-template name="capitalize"><xsl:with-param name="value" select="@name"/></xsl:call-template>"&gt;
-    &lt;element name="<xsl:value-of select="@name"/>"&gt;
-      &lt;!-- <xsl:value-of select="normalize-space(shortdesc)"/> --&gt;
+    &lt;element name="<xsl:value-of select="@name"/>" rha:description="<xsl:value-of select="normalize-space(shortdesc)"/>"&gt;
       &lt;choice&gt;
       &lt;group&gt;
         &lt;!-- rgmanager specific stuff --&gt;
-        &lt;attribute name="ref"/&gt;
+        &lt;attribute name="ref" rha:description="Reference to existing <xsl:value-of select="@name"/> resource in the resources section."/&gt;
       &lt;/group&gt;
       &lt;group&gt;<xsl:for-each select="parameters/parameter">
 		<xsl:choose>
 			<xsl:when test="@required = 1 or @primary = 1">
-        &lt;attribute name="<xsl:value-of select="@name"/>"/&gt;</xsl:when>
+        &lt;attribute name="<xsl:value-of select="@name"/>" rha:description="<xsl:value-of select="normalize-space(shortdesc)"/>"/&gt;</xsl:when>
 			<xsl:otherwise>
         &lt;optional&gt;
-          &lt;attribute name="<xsl:value-of select="@name"/>"/&gt;
+          &lt;attribute name="<xsl:value-of select="@name"/>" rha:description="<xsl:value-of select="normalize-space(shortdesc)"/>"/&gt;
         &lt;/optional&gt;</xsl:otherwise>
 		</xsl:choose>
 	</xsl:for-each>
       &lt;/group&gt;
       &lt;/choice&gt;
       &lt;optional&gt;
-        &lt;attribute name="__independent_subtree"/&gt;
+        &lt;attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/&gt;
       &lt;/optional&gt;
       &lt;optional&gt;
-        &lt;attribute name="__enforce_timeouts"/&gt;
+        &lt;attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/&gt;
       &lt;/optional&gt;
       &lt;optional&gt;
-        &lt;attribute name="__max_failures"/&gt;
+        &lt;attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/&gt;
       &lt;/optional&gt;
       &lt;optional&gt;
-        &lt;attribute name="__failure_expire_time"/&gt;
+        &lt;attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/&gt;
       &lt;/optional&gt;
       &lt;optional&gt;
         &lt;ref name="CHILDREN"/&gt;
diff --git a/rgmanager/src/resources/resources.rng.tail b/rgmanager/src/resources/resources.rng.tail
index c273680..765c2d9 100644
--- a/rgmanager/src/resources/resources.rng.tail
+++ b/rgmanager/src/resources/resources.rng.tail
@@ -14,16 +14,16 @@
 
   <define name="RESOURCEACTION">
    <zeroOrMore>
-    <element name="action">
-     <attribute name="name"/>
+    <element name="action" rha:description="Overrides resource action timings for a resource instance.">
+     <attribute name="name" rha:description="Name of resource action (start, stop, status, etc.)."/>
      <optional>
-      <attribute name="depth"/>
+      <attribute name="depth" rha:description="Status check depth (resource agent dependent; * = all depths)."/>
      </optional>
      <optional>
-      <attribute name="interval"/>
+      <attribute name="interval" rha:description="Status check interval."/>
      </optional>
      <optional>
-      <attribute name="timeout"/>
+      <attribute name="timeout" rha:description="Action timeout.  Meaningless unless __enforce_timeouts is set for this resource."/>
      </optional>
     </element>
    </zeroOrMore>


More information about the cluster-commits mailing list