diff --git a/doc/src/05100-lib-rt.md b/doc/src/05100-lib-rt.md index 859eb1b8..b296ba7b 100644 --- a/doc/src/05100-lib-rt.md +++ b/doc/src/05100-lib-rt.md @@ -9,3 +9,8 @@ It also contains the store object and creates it from configuration. the `libimagrt::runtime::Runtime` object is the first complex object that comes to live in a imag binary. +### Long-term TODO + +- [ ] Merge with `libimagstore` +- [ ] Merge with `libimagstorestdhook` + diff --git a/doc/src/05100-lib-store-std-hook.md b/doc/src/05100-lib-store-std-hook.md new file mode 100644 index 00000000..1e1414cf --- /dev/null +++ b/doc/src/05100-lib-store-std-hook.md @@ -0,0 +1,15 @@ +## libimagstorestdhook + +The `libimagstorestdhook` is a library for default store hooks which are shipped +with the imag store. +Hooks are actions which can be performed before and after certain store actions, +for example before a file is created, or after a file is removed. + +### Long-term TODO + +- [ ] Merge with `libimagrt` +- [ ] Merge with `libimagstorestdhook` +- [ ] Create Runtime-wide "Store meta data" storage in the Runtime, which can be + set by users during the runtime of imag and then used by the hooks to get meta + information about their own runtime. + diff --git a/doc/src/05100-lib-store.md b/doc/src/05100-lib-store.md index b87482dc..2055038b 100644 --- a/doc/src/05100-lib-store.md +++ b/doc/src/05100-lib-store.md @@ -9,3 +9,9 @@ on-the-fly modification of incoming/outgoing files and so on. The store itself does not offer functionality, but has a commandline interface "imag-store" which can do basic things with the store. + +### Long-term TODO + +- [ ] Merge with `libimagrt` +- [ ] Merge with `libimagstorestdhook` + diff --git a/libimagstorestdhook/README.md b/libimagstorestdhook/README.md new file mode 120000 index 00000000..495accc7 --- /dev/null +++ b/libimagstorestdhook/README.md @@ -0,0 +1 @@ +../doc/src/05100-lib-store-std-hook.md \ No newline at end of file