matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add paragraph on store path links

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

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

@ -97,4 +97,32 @@ sub-folders like this:
/module/some/sub/folder/example~0.1
```
## Store path links {#sec:thestore:links}
Linking entries MUST BE version independent.
This means if an entry "a" from a module "A" gets written to the store, it may
link to an entry "b" from a module "B", which is in version "0.1" at the moment.
If the module "B" gets updated, it might update its entries in the store as
well.
The link from the "a" MUST NOT get invalid in this case.
This is accomplished by linking without the version number: So a link for the
entry
```
/module/some/sub/folder/example~0.1
```
is
```
imag://module/some/sub/folder/example
```
As shown in the example, a link to imag-internal entries, the link is prefixed
with a "imag://" identifier.
A link to external content MUST NEVER be prefixed this way.
The path of the internal link MUST NEVER be relative, but always absolute from
the root directory of the store.