updated docs
This commit is contained in:
@@ -326,6 +326,7 @@ The following table is giving a list of error code with explanation:
|
|||||||
| 15 | Bad chrooted installation, destination OS needs to be fixed |
|
| 15 | Bad chrooted installation, destination OS needs to be fixed |
|
||||||
| 16 | Invalid options provided with cron mode activated |
|
| 16 | Invalid options provided with cron mode activated |
|
||||||
| 17 | Missing or invalid status file, can't resume |
|
| 17 | Missing or invalid status file, can't resume |
|
||||||
|
| 18 | Module file don't exists or is empty |
|
||||||
| 50..100 | Error in module execution |
|
| 50..100 | Error in module execution |
|
||||||
| 126 | Command exists but is not executable |
|
| 126 | Command exists but is not executable |
|
||||||
| 127 | Command not found |
|
| 127 | Command not found |
|
||||||
|
|||||||
19
doc/dev.md
19
doc/dev.md
@@ -566,7 +566,7 @@ associated to the corresponding parameter:
|
|||||||
| Parameter | Variable | Type | Descrition |
|
| Parameter | Variable | Type | Descrition |
|
||||||
|:--------------|:-------------------|:--------|:------------------------------|
|
|:--------------|:-------------------|:--------|:------------------------------|
|
||||||
| --help | *none* | *n/a* | Trigger help display directly and exit |
|
| --help | *none* | *n/a* | Trigger help display directly and exit |
|
||||||
| --version | *none* | *n/a* | Trigger help display directly and exit |
|
| --version | *none* | *n/a* | Trigger version display directly and exit |
|
||||||
| --module | MANUAL_MODULE_LIST | string | The following parameter will set a list of module to use |
|
| --module | MANUAL_MODULE_LIST | string | The following parameter will set a list of module to use |
|
||||||
| --check-only | CHECK_ONLY | boolean | Activate check only mode |
|
| --check-only | CHECK_ONLY | boolean | Activate check only mode |
|
||||||
| --jump | JUMP | boolean | Activate no checks mode |
|
| --jump | JUMP | boolean | Activate no checks mode |
|
||||||
@@ -612,8 +612,25 @@ of the time a basic package manager configuration will be required to make it
|
|||||||
work.
|
work.
|
||||||
|
|
||||||
#### 10.1.4. ```load_configuration```
|
#### 10.1.4. ```load_configuration```
|
||||||
|
That function loads configuration files. It will first check for configuration
|
||||||
|
given as command line parameter. If no such parameter exists, it will try to
|
||||||
|
load a file named ```conf/${HOSTNAME}.conf.sh```. If that file don't exists, the
|
||||||
|
generic configuration will be loaded in the file ```conf/init.conf.sh```.
|
||||||
|
|
||||||
|
If no configuration file can be found the function will trigger an error and
|
||||||
|
exit the script.
|
||||||
|
|
||||||
#### 10.1.5. ```process_commandline_and_vars```
|
#### 10.1.5. ```process_commandline_and_vars```
|
||||||
|
That function have the role to check the concistancy of command line parameters.
|
||||||
|
It will triger errors if incompatible parameters have been given or if those
|
||||||
|
parameters might lead to a non predictable situation.
|
||||||
|
|
||||||
|
When those checks are done, the definitive module list to load is created. With
|
||||||
|
that list we then checks the modules are available and do not contain the dash
|
||||||
|
character.
|
||||||
|
|
||||||
|
That function will also triger an error if the definitive module list is empty.
|
||||||
|
|
||||||
|
|
||||||
-----------------------------------------------------------------------------
|
-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|||||||
@@ -174,6 +174,14 @@ You asked to resume on last error, but no status file can be found.
|
|||||||
To fix this, remove the ```--resume``` option. You can use the ```--modules```
|
To fix this, remove the ```--resume``` option. You can use the ```--modules```
|
||||||
option instead to ask for a limited range of modules.
|
option instead to ask for a limited range of modules.
|
||||||
|
|
||||||
|
## Error #18: Module file don't exists or is empty
|
||||||
|
The module list contains an entry that correspond to no module in the "modules"
|
||||||
|
directory or the corresponding file is actually empty.
|
||||||
|
|
||||||
|
Check the spelling of the incriminated module. If spelling is correct, check the
|
||||||
|
file name of that module. If it don't exists, create the module or remove it
|
||||||
|
from the module list.
|
||||||
|
|
||||||
## Error #50 to #100: Error in module execution
|
## Error #50 to #100: Error in module execution
|
||||||
A module trigered an internal error while executing change to the system. You
|
A module trigered an internal error while executing change to the system. You
|
||||||
need to check the concerned module documentation.
|
need to check the concerned module documentation.
|
||||||
@@ -219,6 +227,7 @@ Check the error in the program emiting it and the associated program
|
|||||||
documentation.
|
documentation.
|
||||||
|
|
||||||
-----------------------------------------------------------------------------
|
-----------------------------------------------------------------------------
|
||||||
|
|
||||||
Documentation (c) 2019-2021 Geoffray Levasseur.
|
Documentation (c) 2019-2021 Geoffray Levasseur.
|
||||||
|
|
||||||
This file is distributed under3-clause BSD license. The complete license
|
This file is distributed under3-clause BSD license. The complete license
|
||||||
|
|||||||
Reference in New Issue
Block a user