summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2017-02-21 11:15:09 +0100
committerGitHub <noreply@github.com>2017-02-21 11:15:09 +0100
commitdc1c4733772da76d41af5c5a4e42c4927fb1c9cc (patch)
treea97f3585b8d44bfe5ef6e45675aa71c460b5eaa7
parentb67b6f53434eb551fa45b50d616f805dd39bc96b (diff)
parentccad8309537ba0ba60bb7d6406b9e871b8c5f897 (diff)
downloadimag-dc1c4733772da76d41af5c5a4e42c4927fb1c9cc.zip
imag-dc1c4733772da76d41af5c5a4e42c4927fb1c9cc.tar.gz
Merge pull request #901 from matthiasbeyer/libimag-todos
Libimag todos
-rw-r--r--doc/src/05100-lib-ref.md15
-rw-r--r--doc/src/05100-lib-rt.md5
-rw-r--r--doc/src/05100-lib-store-std-hook.md17
-rw-r--r--doc/src/05100-lib-store.md6
l---------libimagstorestdhook/README.md1
5 files changed, 44 insertions, 0 deletions
diff --git a/doc/src/05100-lib-ref.md b/doc/src/05100-lib-ref.md
index f1c713b..ce18c29 100644
--- a/doc/src/05100-lib-ref.md
+++ b/doc/src/05100-lib-ref.md
@@ -52,3 +52,18 @@ content hash (which is stored in the header of the store entry).
The reference object can, after the path was re-found, be updated.
+### Long-term TODO
+
+Things which have to be done here or are not yet properly tested:
+
+- [ ] Testing of different Hashers
+- [ ] Testing of re-finding of objects, including:
+ - [ ] Can a moved file automatically be found by content hash?
+ - [ ] Does a store-reference get updated automatically if it was moved,
+ including links (as in `libimaglink`)?
+ - [ ] If the content of a file changes, does the content hash get updated
+ automatically?
+
+("automatically" is a strechable term here, as these things have to be triggered
+by the user anyways)
+
diff --git a/doc/src/05100-lib-rt.md b/doc/src/05100-lib-rt.md
index 859eb1b..b296ba7 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 0000000..72972b0
--- /dev/null
+++ b/doc/src/05100-lib-store-std-hook.md
@@ -0,0 +1,17 @@
+## 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.
+- [ ] Implement parallel store hook execution
+- [ ] Implement Non-Mutable store hook execution
+
diff --git a/doc/src/05100-lib-store.md b/doc/src/05100-lib-store.md
index b87482d..2055038 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 0000000..495accc
--- /dev/null
+++ b/libimagstorestdhook/README.md
@@ -0,0 +1 @@
+../doc/src/05100-lib-store-std-hook.md \ No newline at end of file