Update mbase-dir documentation.
This commit is contained in:
parent
9123573267
commit
ded69fac1b
1 changed files with 7 additions and 5 deletions
12
doc/mbase.md
12
doc/mbase.md
|
@ -310,7 +310,7 @@ Other parts of the string are retained.
|
|||
|
||||
### Member Parser
|
||||
|
||||
This module exports only one function - the ```load-member-file```
|
||||
This module exports only one function - the ```load-brmember-file```
|
||||
which loads and parses given file as member file. The specification of
|
||||
this file format is in a separate document ```MEMBERS.md```.
|
||||
|
||||
|
@ -343,7 +343,7 @@ are collected as lists of values.
|
|||
A list of start/stop specifications - each key is paired with given
|
||||
key and start/stop tag.
|
||||
|
||||
(load-member-file mr)
|
||||
(load-brmember-file mr)
|
||||
|
||||
* ```mr``` - (almost) empty member record structure
|
||||
|
||||
|
@ -352,7 +352,9 @@ It must be possible to get the member file using
|
|||
lines, processes these lines with 1st and 2nd pass parsers, interprets
|
||||
the result using 3rd passes and finalizes the result in the 4th pass.
|
||||
|
||||
### Members Directory
|
||||
### Members Base Directory
|
||||
|
||||
(import mbase-dir)
|
||||
|
||||
This module encapsulates the members base directory format as
|
||||
documented in ```MEMBERS.md``` document.
|
||||
|
@ -366,14 +368,14 @@ In first pass it extracts all files and symlinks to them, binds them
|
|||
together and makes sure the 4-digit name is used as id and the regular
|
||||
file is read when loading its contents.
|
||||
|
||||
(load-members-dir dn)
|
||||
(load-mbase-dir dn)
|
||||
|
||||
* ```dn``` - directory name (path)
|
||||
|
||||
Scans given directory and returns a dictionary of canonical names as
|
||||
keys and lists of alias symlinks as values.
|
||||
|
||||
(members-dir-load-member mdir fname symlinks)
|
||||
(mbase-dir-load-member mdir fname symlinks)
|
||||
|
||||
* ```mdir``` - members directory name (path)
|
||||
* ```fname``` - file name inside ```mdir``` (without path)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue