]> git.ipfire.org Git - nitsi.git/commitdiff
man: Improve grammar, spelling and syntax of nitsi.recipe.5
authorMichael Tremer <michael.tremer@ipfire.org>
Fri, 18 May 2018 13:33:56 +0000 (14:33 +0100)
committerJonatan Schlag <jonatan.schlag@ipfire.org>
Sat, 19 May 2018 08:25:12 +0000 (10:25 +0200)
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
man/nitsi.recipe.xml

index 330f33d60b928832f1a773edcd26e5d300654863..73c680dfa9e4ff0157f3fbea85dbda0b354ec353 100644 (file)
@@ -33,7 +33,7 @@
 
                <para>
                        The <filename>recipe</filename> file contains the actions for a test.
-                       So it consist of lines which state which command should executed on which machine.
+                       It consists of lines which state what commands should be executed on which machine.
                </para>
        </refsect1>
 
@@ -41,7 +41,7 @@
                <title>Basic Syntax</title>
 
                <para>
-                       All lines follows the following syntax:
+                       All lines follow the following syntax:
                </para>
 
                <variablelist>
 
                                <listitem>
                                        <para>
-                                               The machine name is the first part of the line followed by an ':'.
+                                               The machine name is the first part of the line followed by ':'.
                                                After the ':' follows the command which should be executed.
                                        </para>
-
                                </listitem>
                        </varlistentry>
                </variablelist>
 
                                <listitem>
                                        <para>
-                                               The '!' is similar to the 'not' in python. So this line will fail if the command succeds
-                                               and succeds if the command fails. Between the machine name and the '!' must be a space.
+                                               The '!' is similar to the 'not' in python. So this line will fail if the command succeeds
+                                               and succeeds if the command fails. Between the machine name and the '!' must be a space.
                                        </para>
-
                                </listitem>
                        </varlistentry>
 
@@ -92,7 +90,6 @@
                                        <para>
                                                This command is executed on all machines of this test.
                                        </para>
-
                                </listitem>
                        </varlistentry>
                        <varlistentry>
 
                                <listitem>
                                        <para>
-                                               This command is on all machines of the comma seperated list. So on machine1 and on machine2.
+                                               This command is on all machines of the comma seperated list.
                                        </para>
-
                                </listitem>
                        </varlistentry>
 
-                                               <varlistentry>
+                       <varlistentry>
                                <term>
                                        <option>include: ../test2</option>
                                </term>
                                <listitem>
                                        <para>
                                                This will include the recipe of test2.
-                                               The path is relativ to the directory of the recipe file which contain the include statement.
+                                               The path is relative to the directory of the
+                                               recipe file which contains the include statement.
                                        </para>
-
                                </listitem>
                        </varlistentry>
-
                </variablelist>
        </refsect1>
 
                                <member>include: ../test2</member>
                        </simplelist>
                </example>
-
        </refsect1>
 
        <refsect1>