matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

doc: Add note that sorting in collections is no hard rule

Browse source 
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
This commit is contained in:
Matthias Beyer 2018-12-05 16:09:36 -08:00
parent de8e065eec
commit 5775a3461a
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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