From 59756bb80b3403813c51e1d4e1ca42dee5985e4f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Poulin?= <jeromepoulin@gmail.com>
Date: Tue, 9 Apr 2024 22:17:45 -0400
Subject: [PATCH] Add missing documentation for `` variable2`` in <test> and
 <strcmp>

---
 docs/scenarios/actions.rst | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/docs/scenarios/actions.rst b/docs/scenarios/actions.rst
index ae0ffb32..fa63840c 100644
--- a/docs/scenarios/actions.rst
+++ b/docs/scenarios/actions.rst
@@ -354,12 +354,14 @@ A string variable and a value can be compared using the <strcmp>
 action. The result is a double value, that is less than, equal to, or
 greater than zero if the variable is lexographically less than, equal
 to, or greater than the value. The parameters are assign_to, variable,
-and value. For example::
+and value or variable2. For example::
 
     <nop>
       <action>
-        <!-- Compare the value of $strvar to "Hello" and assign it to $result.. -->
+        <!-- Compare the value of $strvar to "Hello" and assign it to $result. -->
         <strcmp assign_to="result" variable="strvar" value="Hello" />
+        <!-- Compare the value of $strvar to the value of $othervar. -->
+        <strcmp assign_to="result" variable="strvar" variable2="othervar" />
       </action>
     </nop>
 
@@ -369,17 +371,19 @@ Variable Testing
 ++++++++++++++++
 
 Variable testing allows you to construct loops and control structures
-using call variables. THe test action takes four arguments: variable
-which is the variable that to compare against value , and assign_to
-which is a boolean call variable that the result of the test is stored
-in. Compare may be one of the following tests: equal , not_equal ,
-greater_than , less_than , greater_than_equal , or less_than_equal .
-
-Example that sets ``$2`` to true if ``$1`` is less than 10::
+using call variables. The test action takes four arguments: variable
+which is the variable to compare against, either value or variable2,
+assign_to which is a boolean call variable with the result of the
+test and compare. Compare may be one of the following tests: equal,
+not_equal, greater_than, less_than, greater_than_equal or
+less_than_equal. For example::
 
     <nop>
       <action>
+        <!-- Sets ``$2`` to true if ``$1`` is less than 10 -->
         <test assign_to="2" variable="1" compare="less_than" value="10" />
+        <!-- Sets ``mycheck`` to true when strings in ``myvar`` and ``thatvar`` are equal -->
+        <test assign_to="mycheck" variable="myvar" compare="equal" variable2="thatvar" />
       </action>
     </nop>