From: Michael Tremer <michael.tremer@ipfire.org>
To: development@lists.ipfire.org
Subject: [PATCH 4/7] man: Improve grammar, spelling and syntax of nitsi.recipe.5
Date: Fri, 18 May 2018 14:33:56 +0100 [thread overview]
Message-ID: <20180518133359.2481778-4-michael.tremer@ipfire.org> (raw)
In-Reply-To: <20180518133359.2481778-1-michael.tremer@ipfire.org>
[-- Attachment #1: Type: text/plain, Size: 2806 bytes --]
Signed-off-by: Michael Tremer <michael.tremer(a)ipfire.org>
---
man/nitsi.recipe.xml | 24 +++++++++---------------
1 file changed, 9 insertions(+), 15 deletions(-)
diff --git a/man/nitsi.recipe.xml b/man/nitsi.recipe.xml
index 330f33d60b92..73c680dfa9e4 100644
--- a/man/nitsi.recipe.xml
+++ b/man/nitsi.recipe.xml
@@ -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>
@@ -52,10 +52,9 @@
<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>
@@ -76,10 +75,9 @@
<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>
@@ -102,13 +99,12 @@
<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>
@@ -116,12 +112,11 @@
<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>
@@ -139,7 +134,6 @@
<member>include: ../test2</member>
</simplelist>
</example>
-
</refsect1>
<refsect1>
--
2.17.0
next prev parent reply other threads:[~2018-05-18 13:33 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-18 13:33 [PATCH 1/7] man: Fix spelling issues, wording and wrong page references in nitsi.1 Michael Tremer
2018-05-18 13:33 ` [PATCH 2/7] man: the nitsi.settings and nitsi.recipe pages should be category 5 Michael Tremer
2018-05-18 13:33 ` [PATCH 3/7] man: Fix spelling, wording and formatting of nitsi.settings.5 Michael Tremer
2018-05-18 13:33 ` Michael Tremer [this message]
2018-05-18 13:33 ` [PATCH 5/7] Refactoring of Disk class Michael Tremer
2018-05-18 13:33 ` [PATCH 6/7] .gitignore: Don't list generated man pages as untracked files Michael Tremer
2018-05-18 13:33 ` [PATCH 7/7] .gitignore: Don't list generated nitsi script as untracked file Michael Tremer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180518133359.2481778-4-michael.tremer@ipfire.org \
--to=michael.tremer@ipfire.org \
--cc=development@lists.ipfire.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox