Proposed cleanup for README.md

README.md

@@ -8,6 +8,7 @@ The `package_check.sh` script perform a series of tests on a package for verify
 The test results are printed directly in the terminal and stored in the log file Test_results.log
 
 The script is able to perform the following tests:
+
 - [Linter](https://github.com/YunoHost/package_linter)
 - Install/remove/reinstall at the root of a domain (`domain.tld/`)
 - Install/remove/reinstall in a subpath (`domain.tld/foobar`)
@@ -64,10 +65,11 @@ to propagate (sigh))
 Then you shall initialize LXD which will ask you a bunch of question. Usually
 answering the default (just pressing enter) to all questions is fine. Just pay
 attention to :
+
 - the storage backend driver. Possibly `zfs` is the best, but requires a kernel >= 5.x
-and corresponding kernel module loaded. You can fallback to the `dir` driver.
+  and corresponding kernel module loaded. You can fallback to the `dir` driver.
 - the size of the default storage it'll create (the default is 5G but you may
-want 10G for heavy usage ?) (if you're using the 'dir' driver, this won't be asked)
+  want 10G for heavy usage ?) (if you're using the 'dir' driver, this won't be asked)
 
 ```bash
 lxd init
@@ -109,6 +111,7 @@ lxc image export images:debian/buster/armhf
 ```
 
 This command will create two files.
+
 - rootfs.squashfs
 - lxd.tar.xz
 
@@ -136,14 +139,18 @@ lxc exec inspired-lamprey -- dpkg --print-architecture
 If the `build_base_lxc.sh` script detects that you are trying a cross container architecture, it will try to perform this hack
 
 ## Syntax of `check_process`
+
 > Except spaces, the syntax of this file must be respected.
 
 ```
 ;; Default test serie
 # Comment ignored
 	; pre-install
+		set -euxo pipefail
 		echo -n "Here your commands to execute in the container"
 		echo ", before each installation of the app."
+	; pre-upgrade
+		set -euxo pipefail
 	; Manifest
         # You need to provide default values for installation parameters ...
         # EXCEPT for special args: domain, path, admin, and is_public
@@ -181,38 +188,46 @@ If the `build_base_lxc.sh` script detects that you are trying a cross container
 ```
 
 ### `;; Default test serie`
+
 A name for the series of tests to perform.
 It's possible to create multiple tests series, all with the same syntax.
 All different series will be performed sequentially.
 
 ### `; pre-install`
-*Optional instruction*  
+
+_Optional instruction_
 If you have to execute a command or a group of commands before the installation. You can use this instruction.
 All the commands added after the instruction `; pre-install` will be executed in the container before each installation of the app.
 
 ### `; Manifest`
+
 List of manifest keys.
 All manifest keys need to be filled to perform the installation.
+
 > The manifest keys already in the file here are simply examples. Check the package manifest.
 
 ### `; Actions`
+
 List of arguments for each action that needs an argument.
 `action_argument` is the name of the argument, as you can find at the end of [action.arguments.**action_argument**].
 `arg1|arg2` are the different arguments to use for the tests. You can have as many arguments as you want, each separated by `|`.
 
-*Only `actions.toml` can be tested by package_check, not `actions.json`.*
+_Only `actions.toml` can be tested by package_check, not `actions.json`._
 
 ### `; Config_panel`
+
 List of arguments for each config_panel configuration.
 `main.categorie.config_example` is the complete toml entry for the argument of a configuration.
 `arg1|arg2` are the different arguments to use for the tests. You can as many arguments as you want, each separated by `|`.
 
-*Only `config_panel.toml` can be tested by package_check, not `config_panel.json`.*
+_Only `config_panel.toml` can be tested by package_check, not `config_panel.json`._
 
 ### `; Checks`
+
 List of tests to perform.
 Each test set to 1 will be performed by the script.
 If a test is not in the list, it will be ignored. It's similar to set the test at 0.
+
 - `pkg_linter`: Check the package with [package linter](https://github.com/YunoHost/package_linter)
 - `setup_root`: Installation at the root of a domain.
 - `setup_sub_dir`: Installation in a path.
@@ -223,22 +238,26 @@ If a test is not in the list, it will be ignored. It's similar to set the test a
 - `backup_restore`: Backup then restore.
 - `multi_instance`: Install the application 2 times, to verify its ability to be multi-instanced.
 - `port_already_use`: Provoke an error by opening the port before.
-        The `port_already_use` test may eventually take as argument the port number.  
-        The port number must be written into parentheses.  
+  The `port_already_use` test may eventually take as argument the port number.
+  The port number must be written into parentheses.
 - `change_url`: Try to change the url by 6 different ways. Root to path, path to another path and path to root. And the same thing, to another domain.
 - `actions`: All actions available in actions.toml
 - `config_panel`: All configurations available in config_panel.toml
 
 ### `;;; Upgrade options`
-*Optional instruction*  
+
+_Optional instruction_
 For each specified commit for an upgrade, allow to give a name for this version and the manifest parameters which will be used for the preliminary installation.
 If there's no name specified, the commit will be used.
 And if there's no manifest arguments, the default arguments of the check process will be used.
+
 > 3 variables have to be used for the arguments of the manifest, DOMAIN, PATH and USER.
 
 ---
+
 The `package_check.sh` script accept 6 arguments in addition of the package to be checked.
+
 - `--branch=branch-name`: Check a branch of the repository instead of master. Allow to check a pull request.
-	You can use an url with a branch, https://github.com/YunoHost-Apps/APP_ynh/tree/my_branch, to implicitly use this argument.
+  You can use an url with a branch, https://github.com/YunoHost-Apps/APP_ynh/tree/my_branch, to implicitly use this argument.
 - `--interactive`: Wait for user input between each tests
 - `--help`: Display help.