From f295cd48029621555c841ebcfb68a574d24dcff4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Fri, 24 Mar 2023 22:14:59 +0100 Subject: [PATCH] Add preliminary members base documentation. --- MEMBERS.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 MEMBERS.md diff --git a/MEMBERS.md b/MEMBERS.md new file mode 100644 index 0000000..d09c715 --- /dev/null +++ b/MEMBERS.md @@ -0,0 +1,32 @@ +Members Base +============ + +This file documents the internal structure of the members information +storage. + +Members Directory +----------------- + +Files in this directory with file names being four decimal digits are +member files. The file name is the member id. + +Symlinks to the member files serve as human-readable aliases. + +The implementation handles situation when the human-readable name is +the member file and the symlink is the four-digit member id. + +Member File Preprocessing +------------------------- + +Member files are read line-by-line. + +Comments start with the ```#``` character and continue until the end +of particular line. + +Comments are stripped from each line before parsing. + +Member File Grammar +------------------- + +Member File Schema +------------------