update config file formatting (add dependencies, remove log-level)

This commit is contained in:
askiiart 2025-01-17 17:48:10 -06:00
parent add254d996
commit ecd637af9c
Signed by untrusted user who does not match committer: askiiart
GPG key ID: 6A32977DAF31746A
4 changed files with 43 additions and 26 deletions

View file

@ -14,8 +14,6 @@ Note: This primarily uses LibreWolf and Fedora as examples of packages and distr
## Top-level config
- `log-level` (integer): Log level `0`-`3` (error, warning, info, or debug)
- Default: 1 - warning
- `max-threads` (float): The maximum number of threads to be used
- **See also**: [`threads`](#job-config)
- Default is CPU's threads - 2
@ -48,8 +46,6 @@ Note: This primarily uses LibreWolf and Fedora as examples of packages and distr
- `shell` (string): The shell to run the commands in
- Default: `/bin/sh`
Note: `id` and `revision` are *not* for the package version, they are for
## Packages (`packages`)
Example:
@ -59,6 +55,8 @@ Example:
[packages.librewolf]
dependencies = ["some-librewolf-dependency"]
[packages.librewolf.compilation]
id = "1"
revision = "2"
@ -77,6 +75,8 @@ Example:
volumes = ["librewolf"]
```
Aside from just the jobs, `packages` also contains the `dependencies` field, which lists dependencies for this package which gregory manages - don't list external dependencies in that field.
### Compilation (optional)
Defines the compilation of a program, if applicable. Stuff like Python scripts can skip this.