From mboxrd@z Thu Jan 1 00:00:00 1970 From: Michael Tremer <michael.tremer@ipfire.org> To: development@lists.ipfire.org Subject: [PATCH 3/7] man: Fix spelling, wording and formatting of nitsi.settings.5 Date: Fri, 18 May 2018 14:33:55 +0100 Message-ID: <20180518133359.2481778-3-michael.tremer@ipfire.org> In-Reply-To: <20180518133359.2481778-1-michael.tremer@ipfire.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============8018785203676976097==" List-Id: <development.lists.ipfire.org> --===============8018785203676976097== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Signed-off-by: Michael Tremer <michael.tremer(a)ipfire.org> --- man/nitsi.settings.xml | 58 +++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 32 deletions(-) diff --git a/man/nitsi.settings.xml b/man/nitsi.settings.xml index 8323044d2bee..588a667cac0d 100644 --- a/man/nitsi.settings.xml +++ b/man/nitsi.settings.xml @@ -24,7 +24,7 @@ =20 <refnamediv> <refname>nitsi.settings</refname> - <refpurpose>Settings file for a nitsi test</refpurpose> + <refpurpose>Settings file for a NITSI test</refpurpose> </refnamediv> =20 =20 @@ -32,16 +32,16 @@ <title>Description</title> =20 <para> - The <filename>settings</filename> file is the main configuration file of = the - <command>nitsi</command> test. - This file specifies runtime configuration parameters for the test - and set the virtual environment to use. + The <filename>settings</filename> file is the main configuration file + of a <command>nitsi</command> test. + It specifies runtime configuration parameters for the test + and defines the virtual environment to be used. </para> =20 <para> The syntax of the configuration file is based on the INI configuration - file format. Lines starting with hash (#) or semi-colon (;) - are ignored. + file format. + Lines starting with hash (#) or semi-colon (;) are comments. </para> </refsect1> =20 @@ -55,57 +55,54 @@ <variablelist> <varlistentry> <term> - <option>Name =3D ""</option> + <option>Name</option> </term> =20 <listitem> <para> This option will configure the name of the test - and can be something more human readbale then the name of the test dir= ectory. + and should be in human-readable format. </para> - </listitem> </varlistentry> =20 <varlistentry> <term> - <option>Description =3D ""</option> + <option>Description</option> </term> =20 <listitem> <para> - This can be a short description of the test to explain - what we are trying to test and what results we expect when - we are running the recipe. So when do the test succeed and when do the= test fails. + A short short description of the test to explain + what it is trying to test and what results are expected when + running the recipe. </para> - </listitem> </varlistentry> =20 <varlistentry> <term> - <option>Copy_from =3D ""</option> + <option>Copy_from</option> </term> =20 <listitem> <para> - The files or directories which should be copied into all virtual machi= nes. - The paths are relativ to the path of the test directory. + Lists files or directories which should be copied into + all virtual machines. + The paths are relative to the path of the test directory. </para> - </listitem> </varlistentry> =20 <varlistentry> <term> - <option>Copy_to =3D ""</option> + <option>Copy_to</option> </term> =20 <listitem> <para> - The path to which the files should be copied. For example /root/ + The path to which the files should be copied. For example /root. </para> - </listitem> </varlistentry> =20 @@ -122,27 +119,26 @@ <variablelist> <varlistentry> <term> - <option>Name =3D ""</option> + <option>Name</option> </term> =20 <listitem> <para> - The Name of the virtual environment to use. + The name of the virtual environment to use. </para> - </listitem> </varlistentry> =20 - <varlistentry> + <varlistentry> <term> - <option>path =3D ""</option> + <option>path</option> </term> =20 <listitem> <para> - The path of the virtual environment relativ to the path of the test. + The path of the virtual environment relative to + the path of the test directory. </para> - </listitem> </varlistentry> </variablelist> @@ -156,8 +152,7 @@ <simplelist> <member>[DEFAULT]</member> <member>Name =3D Hello World</member> - <member>Description =3D This is a - short description.</member> + <member>Description =3D This is a short description.</member> <member>Copy_from =3D</member> <member>Copy_to =3D /root/</member> <member>[VIRTUAL_ENVIRONMENT]</member> @@ -165,7 +160,6 @@ <member>path =3D ../virtual-environment/basic</member> </simplelist> </example> - </refsect1> =20 <refsect1> --=20 2.17.0 --===============8018785203676976097==--