From 6525e86f0f6c6bbca50edca0b3bcac1bc1dd33be Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 19 Aug 2014 14:15:06 +0000
Subject: [PATCH] CR-4307 Fix for OPENDJ-1525: Document new maxDuration and warmUpDuration options for xxxrate tools

---
 opendj-sdk/src/main/docbkx/dev-guide/man-searchrate.xml |   28 ++++++++++++++
 opendj-sdk/src/main/docbkx/dev-guide/man-authrate.xml   |   28 ++++++++++++++
 opendj-sdk/src/main/docbkx/dev-guide/man-modrate.xml    |   28 ++++++++++++++
 3 files changed, 84 insertions(+), 0 deletions(-)

diff --git a/opendj-sdk/src/main/docbkx/dev-guide/man-authrate.xml b/opendj-sdk/src/main/docbkx/dev-guide/man-authrate.xml
index 90bcfca..5a2b125 100644
--- a/opendj-sdk/src/main/docbkx/dev-guide/man-authrate.xml
+++ b/opendj-sdk/src/main/docbkx/dev-guide/man-authrate.xml
@@ -78,6 +78,20 @@
      <para>Base DN format string</para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term><option>-B, --warmUpDuration {warmUpDuration}</option></term>
+    <listitem>
+     <para>
+      Warm up duration in seconds
+     </para>
+
+     <para>
+      Default value: 0
+     </para>
+    </listitem>
+   </varlistentry>
+
    <varlistentry>
     <term><option>-c, --numConnections {numConnections}</option></term>
     <listitem>
@@ -85,6 +99,20 @@
      <para>Default value: 1</para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term><option>-d, --maxDuration {maxDuration}</option></term>
+    <listitem>
+     <para>
+      Maximum duration in seconds, 0 for unlimited
+     </para>
+
+     <para>
+      Default value: 0
+     </para>
+    </listitem>
+   </varlistentry>
+
    <varlistentry>
     <term><option>-e, --percentile {percentile}</option></term>
     <listitem>
diff --git a/opendj-sdk/src/main/docbkx/dev-guide/man-modrate.xml b/opendj-sdk/src/main/docbkx/dev-guide/man-modrate.xml
index 4209bc7..054ca25 100644
--- a/opendj-sdk/src/main/docbkx/dev-guide/man-modrate.xml
+++ b/opendj-sdk/src/main/docbkx/dev-guide/man-modrate.xml
@@ -75,6 +75,20 @@
      <para>Base DN format string</para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term><option>-B, --warmUpDuration {warmUpDuration}</option></term>
+    <listitem>
+     <para>
+      Warm up duration in seconds
+     </para>
+
+     <para>
+      Default value: 0
+     </para>
+    </listitem>
+   </varlistentry>
+
    <varlistentry>
     <term><option>-c, --numConnections {numConnections}</option></term>
     <listitem>
@@ -82,6 +96,20 @@
      <para>Default value: 1</para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term><option>-d, --maxDuration {maxDuration}</option></term>
+    <listitem>
+     <para>
+      Maximum duration in seconds, 0 for unlimited
+     </para>
+
+     <para>
+      Default value: 0
+     </para>
+    </listitem>
+   </varlistentry>
+
    <varlistentry>
     <term><option>-e, --percentile {percentile}</option></term>
     <listitem>
diff --git a/opendj-sdk/src/main/docbkx/dev-guide/man-searchrate.xml b/opendj-sdk/src/main/docbkx/dev-guide/man-searchrate.xml
index 5c0dad0..c688862 100644
--- a/opendj-sdk/src/main/docbkx/dev-guide/man-searchrate.xml
+++ b/opendj-sdk/src/main/docbkx/dev-guide/man-searchrate.xml
@@ -79,6 +79,20 @@
      <para>Base DN format string</para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term><option>-B, --warmUpDuration {warmUpDuration}</option></term>
+    <listitem>
+     <para>
+      Warm up duration in seconds
+     </para>
+
+     <para>
+      Default value: 0
+     </para>
+    </listitem>
+   </varlistentry>
+
    <varlistentry>
     <term><option>-c, --numConnections {numConnections}</option></term>
     <listitem>
@@ -86,6 +100,20 @@
      <para>Default value: 1</para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term><option>-d, --maxDuration {maxDuration}</option></term>
+    <listitem>
+     <para>
+      Maximum duration in seconds, 0 for unlimited
+     </para>
+
+     <para>
+      Default value: 0
+     </para>
+    </listitem>
+   </varlistentry>
+
    <varlistentry>
     <term><option>-e, --percentile {percentile}</option></term>
     <listitem>

--
Gitblit v1.10.0