matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Rewrite part on store path format

Browse source
This commit is contained in:
Matthias Beyer 2016-01-19 14:34:58 +01:00
parent a39e3d10e3
commit 78d25ebad7
1 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/src/02000-store.md
View file

@ -71,11 +71,30 @@ So if the store exists in `/home/user/store/`, a file with the Storepath
`/example.file` is (on the filesystem) located at
`/home/user/store/example.file`.
A Storepath contains one predefined part: The module name of the Module the
Entry belongs to, in lowercase letters.
So if a Module named "ExampleModule" stores a file in the Store, the Storepath
for a file with the name "example.file" is "/examplemodule/example.file".
A Storepath contains predefined parts:
* The module name of the Module the Entry belongs to.
This part is a directory.
* The version (semantic versioning applies) of the module storing the Entry
This part is a postfix to the filename
The pattern for the storepath is
```
/<module name>/<optional sub-folders>/<file name>~<sem version>
```
So if a Module named "ExampleModule" with version "0.1" stores a file in the
Store, the Storepath for a file with the name "example" is
"/ExampleModule/example~0.1".
Any number of subdirectories MAY BE used, so creating folder hierarchies is
possible and valid.
A file "example" for a module "module" in version "0.1" would be stored in
sub-folders like this:
```
/module/some/sub/folder/example~0.1
```