added configuration for legos bac-à-sable, improved documentation

This commit is contained in:
levasseur
2021-09-21 17:21:26 +02:00
parent e898eea7f7
commit 1e6f92c25d
6 changed files with 127 additions and 3 deletions

View File

@@ -43,7 +43,7 @@ module name. If that option is provided, the module list is mandatory.
In that situation, no change should be done to the system.
- **-j, --jump**: Jump the checks and goes directly to system transformation.
That option should only be run after successfull checks (eg. after using the
\--checkonly option).
\--check-only option).
- **-k, --keep-going**: The scripts will try to continue even if errors occurs.
Thus some unrecoverable errors might stop the script anyway if it's not allowing
it to work. Please use with care as it might leads to unexpected results.
@@ -51,6 +51,9 @@ it to work. Please use with care as it might leads to unexpected results.
that failed.
- **-R, --no-root-check**: Disable checks on root rights (or the 0 UID).
- **-h, --help**: Display informations on command line usage.
- **-s, --shell**: Launch a shell with entire script's environment for
debugging purpose. No action or modification is made to the system unless you
launch commands manually doing some.
- **-l, --logfile**: Specify a custom name for the logfile. Standard logfile is
named init-hostname-date-time.log in the log subdirectory. That file can also
be customized using the LOGFILE environement variable.
@@ -161,7 +164,15 @@ Unless only configuration files have been changed, any change in the code
implies an increment of a version number in the code **and** a git commit.
```shell
# ------------------------------------------------------------------------------
# Description @template@ module
# Copyright (c) Year Your Name <your.mail@host.tld>
# ------------------------------------------------------------------------------
# <Licence header compatible with BSD-3 licence, you want to use>
# ------------------------------------------------------------------------------
# Variable list:
# * <VARNAME>: role explaination
# ------------------------------------------------------------------------------
# Module version
export VER_@template@="0.0.1"
@@ -182,6 +193,11 @@ precheck_@template@()
export -f @template@
export -f precheck_@template@
```
Unexported template function will work but won't be available in the integrated
debugging shell (see --shell option).
## Error code table
The following table is giving a list of error code with explanation: