matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

doc: Adjust documentation to match implementation

Browse source
This commit is contained in:
Matthias Beyer 2016-03-05 18:51:18 +01:00
parent 09c8b4d561
commit f253931bb7
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/src/04000-lib-store.md
View file

@ -112,9 +112,7 @@ each Hook position. Aspects can be sorted and configured via the configuration
file, whereas each aspect has its own configuration section: file, whereas each aspect has its own configuration section:
```{#lst:hooks:aspects:cfg .toml .numberLines caption="Hook config section"} ```{#lst:hooks:aspects:cfg .toml .numberLines caption="Hook config section"}
[hooks] [store]
[[aspects]]
// Defines order of aspects for the pre-read hook position // Defines order of aspects for the pre-read hook position
pre-read-aspects = [ "misc" ] pre-read-aspects = [ "misc" ]
@ -125,16 +123,21 @@ post-read-aspects = [ "decryption" ]
// ... // ...
// configuration for the "misc" hook aspect // configuration for the "misc" hook aspect
[[misc]] [[aspects.misc]]
parallel-execution = true parallel-execution = true
// configuration for the "decryption" hook aspect // configuration for the "decryption" hook aspect
[[decryption]] [[aspects.decryption]]
parallel-execution = false parallel-execution = false
``` ```
Aspects are executed in the same order they appear in the configuration. Aspects Aspects are executed in the same order they appear in the configuration (in the
_could_ be sorted in different order for each hook position. `pre-read-aspects = []` array, for example).
Aspects _could_ be sorted in different order for each hook position.
Aspect names are unique, so one aspect "misc" in "pre-read-aspects" is the
same as in "post-read-aspects" and both be configured via `aspects.misc`, though
they do not share hooks.
Aspects where parallel execution is enabled MAY BE executed in sequence if one Aspects where parallel execution is enabled MAY BE executed in sequence if one
of the hooks wants mutable access to the data they hook into. of the hooks wants mutable access to the data they hook into.