From 4e7fbb2df9784e8f96460776e9f576f10616fa7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Thu, 23 Mar 2023 09:10:23 +0100 Subject: [PATCH] Document configuration module. --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README.md b/README.md index 0ce672e..db5a6dd 100644 --- a/README.md +++ b/README.md @@ -83,8 +83,49 @@ Building the import module files, shared and static binaries together: Functional Modules ------------------ +These modules are specific to this project and their generic usage is +questionable. + ### Configuration +The exact behavior of some algorithms in other modules can be changed +via configuration parameters in this global configuration module. + + (*current-month* [month]) + +* ```month``` - valid month structure as specified in the ```month``` module + +Configuration parameter specifying the current month. Defaults to the +current month derived from the current system time. + + (*member-file-context* [lines]) + +* ```lines``` - number of context lines + +How many lines of context are to be shown in source file +listing. Mainly used by the member file module parser and processor. + + (*member-file-check-syntax* [mode]) + +* ```mode``` - mode symbol + +Configures syntax error handling when parsing member files. Known +modes are: + +* ```'error``` - raises an error upon encountering error +* ```'warning``` - displays warning and displays relevant part of + member file source with the offending line highlighted. +* ```'quiet``` - supresses any error reporting + +Other values are invalid. + + (*member-default-joined* [month]) + +* ```month``` - valid month as produced by the ```month``` module + +If the member file does not contain the ```joined``` key, this value +is substituted as a default. + ### Member File ### Member Record