Split out specification documentation, prepare for better configuration overides.

This commit is contained in:
Dominik Pantůček 2023-04-16 22:11:57 +02:00
parent 0a49319730
commit 6cf116ce98
3 changed files with 42 additions and 12 deletions

View file

@ -13,29 +13,33 @@ questionable.
### Configuration
(import configuration)
The exact behavior of some algorithms in other modules can be changed
via configuration parameters in this global configuration module.
(*current-month* [month])
This module also handles configuration file loading.
* ```month``` - valid month structure as specified in the ```month``` module
(*etc-hackerbase* path)
Configuration parameter specifying the current month. Defaults to the
current month derived from the current system time.
* ```path``` - path to file with configuration
(*member-file-context* [lines])
Used by ```load-configuration!``` to load the system-specific default
configuration values.
*members-directory*
* ```lines``` - number of context lines
*apikeys-file*
How many lines of context are to be shown in source file
listing. Mainly used by the member file module parser and processor.
*jendasap-checked*
(*member-suspend-max-months* [number])
*bank-dir*
* ```number``` - number of months (nonnegative integer)
*email-from*
(load-configuration!)
Determines how many months the member can be suspended before any
action is required.
Loads configuration from ```(*etc-hackerbase*)``` file.
### Member Record