summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2018-12-05 16:09:36 -0800
committerMatthias Beyer <mail@beyermatthias.de>2019-02-10 17:14:42 +0100
commit5775a3461a2a3008c6450cd666de835c7f9b197e (patch)
treecbc348392c4a9965e5d81381bb48e2285d0680ac /doc
parentde8e065eec377899993aba03b0b030aa4c69ec46 (diff)
doc: Add note that sorting in collections is no hard rule
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/02000-store.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/src/02000-store.md b/doc/src/02000-store.md
index aab16453..07334cea 100644
--- a/doc/src/02000-store.md
+++ b/doc/src/02000-store.md
@@ -103,16 +103,16 @@ necessary.
We name the path to a file in the store "Store id" or "Storepath" and we often
refer to it by using the store location as root.
So if the store exists in `/home/user/store/`, a file with the storepath
-`/example.file` is (on the filesystem) located at
+`example.file` is (on the filesystem) located at
`/home/user/store/example.file`.
By convention, each `libimagentry<name>` and `libimag<name>` module stores its
-entries in in `/<name>/`.
+entries in in `<name>/`.
So, the pattern for the storepath is
```
-/<module name>/<optional sub-folders>/<file name>
+<module name>/<optional sub-folders>/<file name>
```
Any number of subdirectories may be used, so creating folder hierarchies is
@@ -120,9 +120,11 @@ possible and valid.
A file "example" for a module "module" could be stored in sub-folders like this:
```
-/module/some/sub/folder/example
+module/some/sub/folder/example
```
+The above is not enforced or a strict rule, but rather a "rule of thumb".
+
## Backends {#sec:thestore:backends}
The store itself also has a backend. This backend is the "filesystem