summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2019-11-09 17:30:03 +0100
committerMatthias Beyer <mail@beyermatthias.de>2019-12-01 13:03:22 +0100
commit136b4d3dd9acb1d2295f873d4ae227823a945902 (patch)
treeae6dde6a1b24333c1b5a42b22409d948ff015207
parente8f3d26a4bf1fd42d55b0c952a838f85d4c53f23 (diff)
Reword some things on filesystem organization
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
-rw-r--r--doc/src/02000-store.md10
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/src/02000-store.md b/doc/src/02000-store.md
index 2bac11db..cd22d688 100644
--- a/doc/src/02000-store.md
+++ b/doc/src/02000-store.md
@@ -97,15 +97,13 @@ The "Entries" are stored as files in the "Store", which is a directory the
user has access to. The store may exist in the users Home-directory or any
other directory the user has read-write-access to.
-Each module stores its data in an own subdirectory in the store. This is because
-we like to keep things ordered and clean, not because it is technically
-necessary.
+Each module stores its data in an own subdirectory in the store, by convention.
-We name the path to a file in the store "Store id" or "Storepath" and we often
+The path to a file in the store is named "Store id" (or short "ID") and we
refer to it by using the store location as root.
-So if the store exists in `/home/user/store/`, a file with the storepath
+So if the store exists in `/home/user/.imag/store/`, a file with the storepath
`example.file` is (on the filesystem) located at
-`/home/user/store/example.file`.
+`/home/user/.imag/store/example.file`.
By convention, each `libimagentry<name>` and `libimag<name>` module stores its
entries in in `<name>/`.