summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2016-01-19 14:34:58 +0100
committerMatthias Beyer <mail@beyermatthias.de>2016-01-19 16:49:14 +0100
commit78d25ebad70f0e446f9d7d6692f0ce6a354d39b4 (patch)
tree0d0623df22bd6467ebb95cce2be31446e771dbec /doc
parenta39e3d10e3955818e20664f6ecccefa4a56e0373 (diff)
Rewrite part on store path format
Diffstat (limited to 'doc')
-rw-r--r--doc/src/02000-store.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/doc/src/02000-store.md b/doc/src/02000-store.md
index cbe22037..482facbb 100644
--- a/doc/src/02000-store.md
+++ b/doc/src/02000-store.md
@@ -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
+```
+