Small doc fixes.
This commit is contained in:
parent
a7bf9cee94
commit
9a29c526fb
11
README.md
11
README.md
@ -45,10 +45,11 @@ Where:
|
|||||||
The list of packages installed in the container, depending on the package managers, Git packages and other miscellaneous packages given in the config file, in the form of a CSV file, with the following columns in order:
|
The list of packages installed in the container, depending on the package managers, Git packages and other miscellaneous packages given in the config file, in the form of a CSV file, with the following columns in order:
|
||||||
|
|
||||||
| Package name | Version | Package manager |
|
| Package name | Version | Package manager |
|
||||||
|
|--------------|---------|-----------------|
|
||||||
|
|
||||||
For Git packages, the hash of the last commit is used as version number. For miscellaneous packages, the hash of the file that has been used to install the package is used as version number.
|
For Git packages, the hash of the last commit is used as version number. For miscellaneous packages, the hash of the file that has been used to install the package is used as version number.
|
||||||
|
|
||||||
### Log file
|
### Output log
|
||||||
|
|
||||||
Just a plain text file containing the output of the script.
|
Just a plain text file containing the output of the script.
|
||||||
|
|
||||||
@ -57,19 +58,21 @@ Just a plain text file containing the output of the script.
|
|||||||
The log of the failed attempts to build the Docker image, in the form of a CSV file, with the following columns in order:
|
The log of the failed attempts to build the Docker image, in the form of a CSV file, with the following columns in order:
|
||||||
|
|
||||||
| Config file path | Timestamp | Reason category |
|
| Config file path | Timestamp | Reason category |
|
||||||
|
|------------------|-----------|-----------------|
|
||||||
|
|
||||||
The timestamp corresponds to when the error is being logged, not to when it happened.
|
The timestamp corresponds to when the error is being logged, not to when it happened.
|
||||||
|
|
||||||
The following are the categories of reasons explaining why the building failed:
|
The following are the categories of reasons explaining why the building failed:
|
||||||
- "package_unavailable": A command requested the installation of a package that is not available.
|
- `package_unavailable`: A command requested the installation of a package that is not available.
|
||||||
- "baseimage_unavailable": The base image needed for this container is not available.
|
- `baseimage_unavailable`: The base image needed for this container is not available.
|
||||||
- "unknown_error": Any other error.
|
- `unknown_error`: Any other error.
|
||||||
|
|
||||||
### Artifact hash log
|
### Artifact hash log
|
||||||
|
|
||||||
The log of the hash of the artifact archive file, in the form of a CSV file, with the following columns in order:
|
The log of the hash of the artifact archive file, in the form of a CSV file, with the following columns in order:
|
||||||
|
|
||||||
| Timestamp | Hash |
|
| Timestamp | Hash |
|
||||||
|
|-----------|------|
|
||||||
|
|
||||||
The timestamp corresponds to when the hash has been logged, not to when the artifact has been downloaded.
|
The timestamp corresponds to when the hash has been logged, not to when the artifact has been downloaded.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user