From patchwork Fri May 18 23:33:55 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Tremer X-Patchwork-Id: 1771 Return-Path: Received: from mail01.ipfire.org (unknown [172.28.1.200]) by web02.i.ipfire.org (Postfix) with ESMTP id 3B7B960A29 for ; Fri, 18 May 2018 15:34:21 +0200 (CEST) Received: from mail01.i.ipfire.org (localhost [IPv6:::1]) by mail01.ipfire.org (Postfix) with ESMTP id F139410D22FE; Fri, 18 May 2018 14:34:20 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ipfire.org; s=201801; t=1526650461; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:in-reply-to: references:references:list-id:list-unsubscribe:list-subscribe:list-post; bh=SZKyl6nixFB7KdvsYMDFY11TvurHaGAelgNrguqQeyY=; b=AujTiuu1GPt6uwYwMMLk/dCQswi837rNA9Xx4YnApmG6ZRdgAhDay3/LPeE+Cb0UoPUI4j tC3+3dU+N8ZNWrCdHUTdMfUoFTcxIjW9uATJnip4kWgO8QwGStnpU3xOtlW5Zdo+9O1glX CwX4tcOD4b+y6UyON9tyZ3iXQt4kyRp7vaGbFCYqYJl7VuT7t5XaKCqC3TDqkFQCcr3Lc8 jIMnzdrLCYHkSbaFrfoDzPnlr3Xuo6uEkJ4YvFJbodRtYOe79DAGDZZkluokJBP07PH76q qlU6P4uFUWUQMaHaSLVO9G9+yyC+mr7JGX3lCWNr3T9exZTW0QY22gjFYWAiag== Authentication-Results: mail01.i.ipfire.org; auth=pass smtp.auth=ms smtp.mailfrom=michael.tremer@ipfire.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ipfire.org; s=201801; t=1526650448; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:in-reply-to: references:references; bh=SZKyl6nixFB7KdvsYMDFY11TvurHaGAelgNrguqQeyY=; b=kXdHv2yotjzDMQNsH2f+qWAw1mEojUQNeJlAM0tiMM2clEo+qgBs8YtcgRtNNVdA+5n0OX Ws7a8KdwRmTNb1Z3lLlEDARkcLAjEn7LpzKRc/qrANnEJ76GzVo/Pmn+B/RoczuLyqjpyw nidBIP9kBhwYbQfi6099FrwZOXgDE1McWHUC2Md1tYW6mDvl6MVFJbbEQzFbUE7kCg/KVT ue+IOb7h6iAmMYOfbvhWK2iLTOcKgLoZbrz2+Ij4zbKF23kI+9DpmrP5h4QmubyOIvBpiI mQF2Ae46e29PZQFioCY/3xiH7EdFH7cEOtTRIHWpZyZ1je5ElLnB181oqcW5iA== Received: from rice-oxley.tremer.co.uk (unknown [88.98.219.132]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mail01.ipfire.org (Postfix) with ESMTPSA id 4C08D114CC3E; Fri, 18 May 2018 14:34:08 +0100 (BST) From: Michael Tremer 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> X-Mailer: git-send-email 2.17.0 In-Reply-To: <20180518133359.2481778-1-michael.tremer@ipfire.org> References: <20180518133359.2481778-1-michael.tremer@ipfire.org> X-Spamd-Result: default: False [-7.06 / 11.00]; ASN(0.00)[asn:56478, ipnet:88.98.216.0/22, country:GB]; DKIM_SIGNED(0.00)[]; TO_DN_SOME(0.00)[]; FROM_HAS_DN(0.00)[]; RCVD_TLS_ALL(0.00)[]; RCPT_COUNT_TWO(0.00)[2]; ARC_NA(0.00)[]; BAYES_HAM(-3.00)[100.00%]; FROM_EQ_ENVFROM(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; MID_CONTAINS_FROM(1.00)[]; RCVD_COUNT_ZERO(0.00)[0]; MIME_GOOD(-0.10)[text/plain]; NEURAL_HAM(-2.96)[-0.985,0]; REPLY(-2.00)[] X-Spam-Status: No, score=-7.06 X-Rspamd-Server: mail01.i.ipfire.org Cc: Michael Tremer X-BeenThere: development@lists.ipfire.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: IPFire development talk List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: development-bounces@lists.ipfire.org Sender: "Development" Signed-off-by: Michael Tremer --- 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 @@ nitsi.settings - Settings file for a nitsi test + Settings file for a NITSI test @@ -32,16 +32,16 @@ Description - The settings file is the main configuration file of the - nitsi test. - This file specifies runtime configuration parameters for the test - and set the virtual environment to use. + The settings file is the main configuration file + of a nitsi test. + It specifies runtime configuration parameters for the test + and defines the virtual environment to be used. 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. @@ -55,57 +55,54 @@ - + This option will configure the name of the test - and can be something more human readbale then the name of the test directory. + and should be in human-readable format. - - + - 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. - - + - The files or directories which should be copied into all virtual machines. - 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. - - + - The path to which the files should be copied. For example /root/ + The path to which the files should be copied. For example /root. - @@ -122,27 +119,26 @@ - + - The Name of the virtual environment to use. + The name of the virtual environment to use. - - + - + - 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. - @@ -156,8 +152,7 @@ [DEFAULT] Name = Hello World - Description = This is a - short description. + Description = This is a short description. Copy_from = Copy_to = /root/ [VIRTUAL_ENVIRONMENT] @@ -165,7 +160,6 @@ path = ../virtual-environment/basic -