Update to v1.0.2

man/b2bt.5

@@ -44,7 +44,7 @@ XML file starts with a line indicating the XML version we use:
 .Pp
 Then, all the rest of the file is enclosed between 1 test-suite pair of tags: 
 .Bd -literal
-<test-suite program="COMMAND" processor="b2bt" ID="@(#) $Id: COMMAND.xml - back to back test suite for COMMAND v1.0.0 (DATE) by AUTHOR $">
+<test-suite program="COMMAND" processor="b2bt B2BT_VERSION" ID="@(#) $Id: COMMAND.xml - back to back test suite for COMMAND vVERSION (DATE) by AUTHOR $">
 </test-suite>
 .Ed
 .Pp
@@ -54,11 +54,17 @@ Where:
 .Em COMMAND
 is the name of the command to be tested
 .It
+.Em VERSION
+is the version of the test suite
+.It
 .Em DATE
 is the date of last modification to the file
 .It
 .Em AUTHOR
 is the test suite author's name
+.It
+.Em B2BT_VERSION
+is the minimal version required of **b2bt** required to process this file, or 1.0.x if missing
 .El
 .Pp
 You can then have 1 or more test-cases enclosed between test-case pair of tags:
@@ -96,6 +102,24 @@ the command itself must be pathless. b2bt will replace the first occurrence it f
 .It
 the command is executed by a Shell. Its output can be piped to another command or redirected to a file, and it can be prefixed by environment variables definition
 .El
+.It
+There are 2 characters that you must escape in all XML tag contents:
+.Bl -bullet
+.It
+The ampersand (&) is to be replaced by &amp;
+.It
+The "less than" operator (<) is to be replaced by &lt;
+.El
+.It
+Also remember that, at least, the predefined XML entities will be replaced in your tag contents. The 2 previous ones, plus:
+.Bl -bullet
+.It
+&quot; for the quote (")
+.It
+&apos; for the apostrophe (')
+.It
+&gt; for the "greater than" operator (>)
+.El
 .El
 .Pp
 Apart from the mandatory
@@ -142,6 +166,9 @@ The temporary directory where the test happens will automatically be cleaned, an
 .Em INPUT_LINES
 is 0 to N lines of text to be injected as standard input into the command to be tested. Again, leading or trailing spaces and newline characters are stripped
 .El
+.Pp
+If you want portable test suites, please make sure that all commands you use
+in the pre, cmd and post sections are available in all the operating systems that you target...
 .Sh EXAMPLES
 A minimal test suite would be:
 .Bd -literal

setup.cfg

@@ -3,7 +3,7 @@ name = pnu_b2bt
 description = Back to Back Testing tool
 long_description = file: README.md
 long_description_content_type = text/markdown
-version = 1.0.1
+version = 1.0.2
 license = BSD 3-Clause License
 license_files = License
 author = HubTou

src/b2bt/main.py

@@ -29,7 +29,7 @@
     COLORAMA = False
 
 # Version string used by the what(1) and ident(1) commands:
-ID = "@(#) $Id: b2bt - back-to-back testing v1.0.1 (June 5, 2021) by Hubert Tournier $"
+ID = "@(#) $Id: b2bt - back-to-back testing v1.0.2 (June 12, 2021) by Hubert Tournier $"
 
 # Default parameters. Can be overcome by environment variables, then command line options
 DEFAULT_TIMEOUT = 120.0