From 8acc57df8f6056a9c7ce2b324b38c6e26392c2d2 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:54:29 +0100 Subject: [PATCH 01/12] Update README for libimagrt --- libimagrt/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/libimagrt/README.md b/libimagrt/README.md index 18696bcf..204770cb 100644 --- a/libimagrt/README.md +++ b/libimagrt/README.md @@ -4,3 +4,8 @@ This library provides utility functionality for the modules and the binary frontends, such as reading and parsing the configuration file, a builder helper for the commandline interface and such. +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. + From c656aa22141c82c737909e827c3a8f06f38827e5 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 02/12] Add README for imag-counter --- imag-counter/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 imag-counter/README.md diff --git a/imag-counter/README.md b/imag-counter/README.md new file mode 100644 index 00000000..2c306afd --- /dev/null +++ b/imag-counter/README.md @@ -0,0 +1,11 @@ +# imag-counter + +A simple module to count things. + +```bash +imag counter create --name example --initval 42 # or: -n example -i 42 +imag counter --inc example # or -i example +imag counter --reset example +imag counter --dev example # or -d example +``` + From dec6a8d854fe313083e4a97c3e7c2f9e0a684b80 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 03/12] Add README for imag-link --- imag-link/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 imag-link/README.md diff --git a/imag-link/README.md b/imag-link/README.md new file mode 100644 index 00000000..8ae15aba --- /dev/null +++ b/imag-link/README.md @@ -0,0 +1,5 @@ +# imag-link + +Utility to link entries. Not meant to be called by normal users but by +developers to investigate the store. + From 0ced21b63a1752913cfca2304dbffc429bbae99f Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 04/12] Add README for imag-store --- imag-store/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 imag-store/README.md diff --git a/imag-store/README.md b/imag-store/README.md new file mode 100644 index 00000000..7ea31f4e --- /dev/null +++ b/imag-store/README.md @@ -0,0 +1,4 @@ +# imag-store + +Minimal commandline interface for the store. Not meant to be called by users but +by developers to investigate the store. From 28a6b1323f072613b7b7a933de7fc3e8bd448ebe Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 05/12] Add README for imag-tag --- imag-tag/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 imag-tag/README.md diff --git a/imag-tag/README.md b/imag-tag/README.md new file mode 100644 index 00000000..ff2847f0 --- /dev/null +++ b/imag-tag/README.md @@ -0,0 +1,4 @@ +# imag-tag + +Commandline frontend for the tagging library. Not meant to be called by the user +but by developers to investigate tags of entries. From fed1f0ca8cacecc3c728e584dde0ba1ad9d57081 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 06/12] Add README for imag-view --- imag-view/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 imag-view/README.md diff --git a/imag-view/README.md b/imag-view/README.md new file mode 100644 index 00000000..3920f204 --- /dev/null +++ b/imag-view/README.md @@ -0,0 +1,4 @@ +# imag-view + +Simple commandline utility to print entries to the commandline output. + From 20b578cd62e41dd6a9c6417eadf0750b3552c237 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 07/12] Add README for libimagcounter --- libimagcounter/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 libimagcounter/README.md diff --git a/libimagcounter/README.md b/libimagcounter/README.md new file mode 100644 index 00000000..7aed8967 --- /dev/null +++ b/libimagcounter/README.md @@ -0,0 +1,4 @@ +# libimagcounter + +Library of "imag-counter", usable by other modules as well to implement counter +functionality for entries. From 68c89ebb36b11c8aa8829405c9c5866df6038f57 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 08/12] Add README for libimagentryfilter --- libimagentryfilter/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 libimagentryfilter/README.md diff --git a/libimagentryfilter/README.md b/libimagentryfilter/README.md new file mode 100644 index 00000000..a939f897 --- /dev/null +++ b/libimagentryfilter/README.md @@ -0,0 +1,9 @@ +# libimagentryfilter + +Helper library to filter lists of entries by certain predicated. Offers filters +for filtering by header values and other predicates, plus this library offers +logical operants to combine filters. + +A commandline-to-filter DSL is planned for this, so commandline applications can +use this to implement a uniform filter interface. + From 7fc7d8a69675bb79caaec41ad7e1069bc645cef5 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 09/12] Add README for libimaglink --- libimaglink/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 libimaglink/README.md diff --git a/libimaglink/README.md b/libimaglink/README.md new file mode 100644 index 00000000..4dc841d9 --- /dev/null +++ b/libimaglink/README.md @@ -0,0 +1,5 @@ +# libimaglink + +Linking library for linking entries with other entries. Used for "imag-link", +the commandline utility, but intended for use in other binaries and libraries as +well. From b54576d95d83c2ea989f6fb3ac81424d9d63268e Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 10/12] Add README for libimagstore --- libimagstore/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 libimagstore/README.md diff --git a/libimagstore/README.md b/libimagstore/README.md new file mode 100644 index 00000000..51c9d49d --- /dev/null +++ b/libimagstore/README.md @@ -0,0 +1,11 @@ +# libimagstore + +The store is the heart of everything. Here lives the data, the complexity and +the performance bottleneck. + +The store offeres read/write access to all entries, a hook system to do +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. + From da8d953f6da617453df2f61578aede6e71b31979 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 11/12] Add README for libimagtag --- libimagtag/README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 libimagtag/README.md diff --git a/libimagtag/README.md b/libimagtag/README.md new file mode 100644 index 00000000..ea8e6564 --- /dev/null +++ b/libimagtag/README.md @@ -0,0 +1,6 @@ +# libimagtag + +Library for tagging entries. Used in "imag-tag" but should be used in all other +modules which contain tagging functionality, so the backend and frontend look +the same for all modules. + From 0d8184451b248826933ac287349c123b4841a3c2 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 25 Mar 2016 15:56:42 +0100 Subject: [PATCH 12/12] Add README for libimagutil --- libimagutil/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 libimagutil/README.md diff --git a/libimagutil/README.md b/libimagutil/README.md new file mode 100644 index 00000000..ba32bcaf --- /dev/null +++ b/libimagutil/README.md @@ -0,0 +1,4 @@ +# libimagutil + +Utility library. Does not depend on other imag crates. +