Commit graph

364 commits

Author SHA1 Message Date
af6d67416b Fix typos 2019-09-20 19:16:22 +02:00
db3bb95227 Add user documentation
This patch adds user documentation in for of a mdbook, using a travis
job for running the build of the book in CI to be sure it builds
properly.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-09-01 13:37:05 +02:00
d759e402a6 Add changelog for 0.9.3
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
(cherry picked from commit 6661b72e3d1a984f3010251698b7ee92be80af1a)
2019-05-25 10:43:59 +02:00
bce167d740 Update changelog for 0.9.2.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
(cherry picked from commit d828e5fd6ff2f13c0737260649c28a8fcaab6299)
2019-05-25 10:43:59 +02:00
21b24e2d26 Remove long-term todos from doc
We really shouldn't have todos in the documentation.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-05-18 01:31:40 +02:00
0d9691ab0b Update header example 2019-04-27 02:05:03 +02:00
29b04a269a doc: Rewrite section on error handling in libraries
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-04-26 16:15:34 +02:00
3d8fef0688 Add changelog for version 0.9.1
This was cherry-picked from the 0.9.1 release, where I made the mistake
to add one commit for all updated stuff, instead of adding the changelog
in one commit and all other stuff in other commits.

But because we should have that information on master, we cherry-pick
the commit 7137a3ce7 partially here.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
(cherry picked from commit 7137a3ce7)
2019-04-26 16:12:23 +02:00
f84cc8169f Revert "Remove libimagmail"
This reverts commit 74045e1800.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-20 16:22:52 +01:00
74045e1800 Remove libimagmail
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-17 11:09:48 +01:00
db7121ccba Rewrite library
* Remove old code
* Rewrite with tests

This implements a fassade pattern for ref library

With the fassade, we can specify the hasher in a rather easy way, which
is not possible with default generics for traits.

The "default" part in "default generic type" is not properly implemented
yet (as visible in the tests), as I don't know how to realize this.

For simplicity, the `hasher` module exports a `default` module with a
`DefaultHasher` type, which resolves to the `Sha1Hasher`.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-17 11:09:48 +01:00
a41479c0ec doc: Rewrite README for libimagentryref 2019-02-17 11:09:48 +01:00
aa5ea533c7 Add imag-header
imag-header is a tool for querying information of an entry in a defined
format.

imag-header is intended for scripting with imag commands.
The output format is not stable yet, though.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-15 20:54:52 +01:00
96a25c18b2 doc: Rewrite imag-mail documentation
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:48 +01:00
73d8d54528 doc: Add notes on CLI conventions
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:45 +01:00
5775a3461a doc: Add note that sorting in collections is no hard rule
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:42 +01:00
de8e065eec doc: Rewrite docs for todo module parts
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:21 +01:00
4e516ee19d Update version strings
...for the next release, which will be imag 0.10.0!

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-11-10 11:56:37 +01:00
dfba366a89 Add changelog for 0.9.0
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-11-09 22:14:11 +01:00
b3b32077a5 Remove empty section
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-11-09 21:48:26 +01:00
8552843796 doc: Add note on IO conventions 2018-11-06 20:32:34 +01:00
8c597d2c4d doc: Document new IO story with libimagrt 2018-11-06 20:32:34 +01:00
b5c73d9c19 doc: Specify how imag-mail should look like 2018-08-26 04:24:57 +02:00
f4e0c1c5eb doc: Add more planned commands for imag-mail 2018-08-26 04:24:57 +02:00
104cbfbfa7 doc: Format for line length 2018-08-26 04:24:57 +02:00
6ba87a58d1 Add 'Known Problems' section 2018-06-23 21:55:35 +02:00
473f962874 Update lib description 2018-06-23 21:55:35 +02:00
cb8c511985 Update lib description 2018-06-23 21:55:35 +02:00
d6a19d8645 Update lib description 2018-06-23 21:55:27 +02:00
5847987404 Remove old statement 2018-06-23 21:54:27 +02:00
869f5377f9 Update intro 2018-06-23 21:54:27 +02:00
6e45727f15 Update conventions 2018-06-23 21:54:27 +02:00
f9294eb07a doc: Update README 2018-06-23 21:54:27 +02:00
33789a0da8 Change contributing documentation
For after we leave github, the documentation on how to  contribute has
to be adjusted.
This patch does this.
2018-06-23 21:54:27 +02:00
664edc7943 Update version string: 0.8.0 -> 0.9.0 2018-05-09 11:39:33 +02:00
be0c8c658b Update date 2018-05-08 21:37:19 +02:00
31e320e2e5 Add changelog for 0.8.0 2018-05-08 21:37:19 +02:00
61d0136c26 imag-category: Initial import 2018-05-04 11:09:20 +02:00
9efa4c715f Add changelog for 0.7.1 2018-05-01 22:29:46 +02:00
563c76c375 Remove "stdio" file abstraction from store implementation 2018-04-24 22:16:40 +02:00
d2dceb6640 Update version numbers: 0.7.0 -> 0.8.0 2018-04-19 10:05:53 +02:00
00affd2056 Update date 2018-04-18 19:34:52 +02:00
4667ec61b5 Move changelog to 0.7.0 section 2018-04-18 19:34:52 +02:00
1188ac4c56 Add changelog from 0.6.4
This changelog was never added to the master branch, which I catch up on
with this commit.
2018-04-18 19:34:52 +02:00
4568b1f625
Merge pull request #1380 from matthiasbeyer/minor
Minor patches
2018-04-18 16:46:41 +02:00
51205af668
Merge pull request #1400 from matthiasbeyer/imag-wiki/init
imag-wiki: init
2018-04-18 15:42:27 +02:00
95d3fbebcc
Merge pull request #1182 from matthiasbeyer/libimagwiki/init
libimagwiki: init
2018-04-18 15:13:56 +02:00
a31c5397d4 Add changelog entry for libimagwiki/imag-wiki 2018-04-18 14:56:31 +02:00
13e6924047
Merge pull request #1359 from matthiasbeyer/doc-writing-modules
Add guide on how to write modules
2018-04-18 14:35:10 +02:00
8dd3a57114 Initial import 2018-04-18 14:32:23 +02:00