Commit graph

334 commits

Author SHA1 Message Date
7c752e8ef3 Update list of library todos 2017-12-20 14:45:26 +01:00
872dbb91e0 Update todo-list of crates which are done 2017-12-20 14:45:02 +01:00
167511afec Fix formatting and adjust module/lib documentation
Also add symlink in module implementation to lib-documentation.
2017-12-08 14:54:40 +01:00
5661dd8e35 Add CHANGELOG entry for imag-contact 2017-11-09 11:25:56 +01:00
eaa9ad5993 Add basic documentation on how the lib works 2017-10-31 19:09:43 +01:00
4250241f18 Try to get RTP from IMAG_RTP 2017-10-31 15:30:29 +01:00
eca7219039 Rewrite configuration providing in runtime
Before the configuration object (the raw TOML object) was provided via a
wrapper object `Configuration`. This was ugly and not very nice to use.

Now, we only have the `toml::Value` object we lend out from
`Runtime::config()`.

The changes included libimagrt internal rewrites, which are not visible
to the user. Anyways, this change changes the API for config-fetching
from the runtime, so fixes for all other crates may follow.

The changes also removed the support for reading the "editor" setting
from the configuration file, which was not used anyways (in the example
imagrc.toml file).
The CLI-reading and ENV-reading are still supported, though.
2017-10-31 09:25:14 +01:00
a5042ba80c Add changelog entry 2017-10-16 14:43:21 +02:00
a3de0f6712 Reword contributing guidelines 2017-10-15 10:56:39 +02:00
cd429a3116 Rewrite module section intro 2017-10-15 10:47:00 +02:00
16ebf52385 Revisit the documentation for the store 2017-10-14 21:52:16 +02:00
6068f2b52d Rephrase architecture doc. 2017-10-14 21:35:55 +02:00
b942b9702d Reword intro 2017-10-14 21:20:45 +02:00
106ba44d4a Update tool todo-list 2017-10-14 15:38:04 +02:00
01f527d7c4 Fix typos 2017-10-14 15:38:00 +02:00
5928968c8f Explain versioning conventions 2017-10-14 15:38:00 +02:00
2de3c512e3 Format markup 2017-10-14 15:37:53 +02:00
fcd30a80ad Revisit doc on entry version
We don't have that concept anymore, remove docs for it.
2017-10-14 15:29:41 +02:00
704c01b2c9 Merge pull request #1130 from matthiasbeyer/imag-annotate/init
Imag annotate/init
2017-10-13 16:20:57 +02:00
1d270ee1cf Add changelog entry 2017-10-13 14:53:57 +02:00
23f4d7948f Fix Store::entries() to not yield directories
Before the iterator did also yield storeids for directories, which was a
bug.

This change introduces a new if_file() function in the store-internal
backend, which is needed to check whether a path actually points to a
File, be it inmemory or on the real filesystem.

That's because tests might fail if they check via PathBuf::is_file() as
in tests, the entries only exist inmemory.
2017-10-13 14:26:06 +02:00
d4633d466e Add changelog entry 2017-10-12 22:15:13 +02:00
Kai Sickeler
1f84643486 Dump all StoreIds
Add StoreId Dump changes
2017-10-09 12:18:27 +02:00
f266791142 Add multi-destination logging to logger
The logger was not able to handle multiple destinations before. Now it
is possible for the logger.

The file must be held behind an Arc<Mutex<_>> so we can use the logging
from multiple threads but also because we need to borrow mutably, so
that bit changes whith this commit.
2017-10-08 18:08:51 +02:00
969211174a Rewrite imag-view
The imag-view command was redesigned with this change. It now looks up
view-templates in the config and calls them with the "in" subcommand.

This way, an entry can be viewed with editor, browser or whatever one
likes.

Compiling markdown is not supported yet.
2017-10-08 15:08:27 +02:00
d9add138d2 Use positional argument for id 2017-10-08 13:02:56 +02:00
c5ad59e96f Initial import of imag-mv 2017-10-01 10:07:29 +02:00
643db0df3a Remove libimagcounter / imag-counter 2017-09-28 22:41:23 +02:00
73f6016221 Update version strings: 0.4.0 -> 0.5.0 2017-09-24 13:05:01 +02:00
8a15aba1d0 Update month in doc 2017-09-23 22:18:28 +02:00
5ed5392193 Finalize changelog 2017-09-23 21:24:46 +02:00
2f2f606924 Add missing changelog entry for imag-gps 2017-09-23 21:19:27 +02:00
441e59753a Merge pull request #1105 from matthiasbeyer/minor
Minor
2017-09-22 16:06:23 +02:00
fbbb26b737 Initial import 2017-09-21 19:01:36 +02:00
5cf4df474a Doc: Todo: Fix indent 2017-09-21 12:29:27 +02:00
e5135aa9d5 Add imag-grep in todo-list, sort 2017-09-21 12:26:28 +02:00
94674841a0 Fix doc: Header structure 2017-09-21 12:21:32 +02:00
8bbaeeef45 Fix: Store::delete() should check FS as well
This patch fixes a problem where the Store::delete() function only
checked the store-internal cache whether an entry exists, but not the
Filesystem. After this patch is applied, the Store::delete() function
also checks the filesystem whether the entry exists.
2017-09-20 22:24:59 +02:00
9b2ceb31cc Merge pull request #1093 from matthiasbeyer/libimagentrylist/rip-out-cli-mod
libimagentrylist: Remove unused module
2017-09-20 22:00:34 +02:00
19c3bc829a Remove unused module 2017-09-20 18:41:54 +02:00
e000957722 Ensure that all arguments are passed to the subcommand 2017-09-20 17:13:04 +02:00
b853e35a05 Merge pull request #1071 from matthiasbeyer/imag-grep
imag-grep: Add new crate
2017-09-15 23:21:18 +02:00
922ed445d4 imag-grep: Add new crate 2017-09-15 21:16:02 +02:00
1ffc45a4c0 Use positional args 2017-09-15 21:07:01 +02:00
cefe58ffd4 Add changelog 2017-09-15 13:53:30 +02:00
2f0fa2b6ca Merge pull request #1068 from matthiasbeyer/imag-timetrack/fix-track-command
Fix: Let the track command parse the start/end time more intelligently
2017-09-15 12:38:42 +02:00
e049559bed Fix: Let the track command parse the start/end time more intelligently
It understands "now" from this point and can parse dates or date-times
(whereas dates get normalized to date + hour 0, minute 0, second 0).
2017-09-14 20:49:10 +02:00
bcb6c7b52d Add changelog entry 2017-09-14 20:06:22 +02:00
8aa5c2d82d Fix header locations
Also change that the implementation uses toml_query::set instead of
toml_query::insert.

Inserting values creates intermediate tables, set doesn't. And we really
want that convenience here, as the code is complex enough on its own.
2017-09-09 16:36:21 +02:00
976f280511 Update toml-query: 0.3.* -> ^0.3.1
This release contains a bugfix for a critical bug in the
`TomlValueInsertExt::insert()` algorithm which was triggered by an
edgecase.
2017-09-06 19:30:32 +02:00
30b466b622 Update changelog 2017-09-05 22:03:13 +02:00
b445cea9e7 Check TODO, add Changelog 2017-09-04 23:09:05 +02:00
336e0fb918 Add changelog 2017-09-03 13:48:36 +02:00
caa8529abc Add libimagentrygps 2017-09-01 20:36:03 +02:00
f71065c24d Add changelog for 0.3.0..master 2017-09-01 14:40:30 +02:00
a5e836fecb Add changelog 2017-09-01 14:25:00 +02:00
29d93a73f0 Merge pull request #1025 from matthiasbeyer/todo/libimagerror
Add todo: Rewrite libimagerror with chain-error crate
2017-08-27 20:07:22 +02:00
e386e86474 Add todo: Rewrite libimagerror with chain-error crate 2017-08-27 17:49:18 +02:00
2fcead5f53 Fix broken README symlinks
Along: Add files in documentation for modules that not yet had one.
2017-08-27 15:13:25 +02:00
Mario Krehl
8a63815854 Fix package name of libimagentryannotation
Fix: run `sed -i 's,libimagref,libimagentryref,g' (rg -l 'libimagref')`
Fix: run `sed -i 's,libimagannotation,libimagentryannotation,g' (rg -l 'libimagannotation')`
2017-08-27 15:13:25 +02:00
1c37703c32 Update version strings for next release: 0.3.0 -> 0.4.0 2017-08-26 13:27:32 +02:00
0f436d5b88 Merge pull request #1009 from matthiasbeyer/doc-overhaul
Doc overhaul
2017-08-25 18:34:11 +02:00
3001288442 Update date 2017-08-25 17:50:38 +02:00
abebf9c014 Fix format 2017-08-25 14:04:18 +02:00
49a7201125 Add documentation how the mail CLI should look like 2017-08-21 00:03:22 +01:00
d7b266a72c Add todos for maintenance scripts 2017-08-20 15:24:48 +01:00
469975d752 Add more ideas for modules 2017-08-20 14:46:34 +01:00
3e115b7014 Add todo for logger rewrite 2017-08-14 09:52:47 +00:00
5fa076914c Add docs on {habit,news,todo,wiki} lib 2017-08-12 21:26:55 +00:00
db51d971cc Improve mail module docs 2017-08-12 21:26:26 +00:00
740a5dad74 Cleanup intro 2017-08-12 21:26:02 +00:00
a96eb69b0f Basic documentation for read/write libs 2017-08-12 15:48:00 +00:00
d78288e6f7 Add files for libs 2017-08-12 15:37:17 +00:00
1c98dca547 Add basic descriptions for as many modules as possible 2017-08-11 22:20:11 +00:00
0e1925e5ae Add three more modules to do 2017-08-11 22:15:53 +00:00
6d73dae8a5 Add files for planned modules 2017-08-11 16:29:38 +00:00
31541fb1ba Fix filename 2017-08-11 12:59:40 +00:00
3d34ea0491 Add long-term todos in todo file 2017-08-11 09:13:42 +00:00
7ab0050a3d Remove outdated parts 2017-08-11 09:11:12 +00:00
7c227b4e4d Move contributing guidelines to documentation 2017-08-11 09:11:12 +00:00
f771337359 Remove 'Backend' sections, we dont need them 2017-08-11 09:03:46 +00:00
471e31172f Remove unused files 2017-08-10 19:47:19 +00:00
25db146dd5 Add architecture (and types) documentation 2017-08-10 19:44:19 +00:00
7a048f3795 Add file for coding conventions and best practices 2017-08-10 16:38:46 +00:00
b3e7f095ce Merge pull request #966 from matthiasbeyer/libimagtimetrack
imag-timetrack / libimagtimetrack
2017-06-29 14:55:39 +02:00
9583ae06cd Add README/documentation 2017-06-26 19:30:02 +02:00
dd7954ddb6 Add Documentation 2017-06-26 19:28:57 +02:00
0033d1b4b4 Add documentation file 2017-06-21 18:29:49 +02:00
266311d743 Change backends to do less ser-/deserialization
This commit changes the backends to do less de/ser, as it now stores the
Entry objects in the backend and does the de/serialization there.

This means the store does only serialize things once from json to toml
in the io backend.

See the diff of the documentation for more details.
2017-06-18 12:32:04 +02:00
c4b2287876 Move the documentation to the docs 2017-06-18 11:33:18 +02:00
9254851724 doc: Remove hook stuff 2017-06-06 11:12:37 +02:00
9650f46e23 Version strings: 0.2.0 -> 0.3.0 2017-05-03 10:48:26 +02:00
ccad830953 Add more long-term todos 2017-02-20 15:13:47 +01:00
d75bc2d928 Add TODOs about libimag{rt,store{,stdhook}} merge 2017-02-20 14:51:06 +01:00
eaf34ac6e9 Add long-term todos in libimagref 2017-02-20 14:51:06 +01:00
3a18655a7f Increment header levels in the README.md I missed in the first run 2016-10-13 12:07:54 +02:00
e30d774670 Move all libimag*/README.md to doc/src/05100-* 2016-10-13 12:04:36 +02:00
a2e2fc93b1 Add library documentation subchapter 2016-10-13 12:04:36 +02:00
da439e60e9 Add documentation what a valid tag is 2016-09-30 10:45:28 +02:00
75f57d622c doc: Fix code listing 2016-07-30 21:36:45 +02:00
34e164e954 doc: Add more description of modules 2016-07-30 21:32:50 +02:00
40d4939f3a doc: Fix up store entry example markup and content 2016-07-30 21:02:21 +02:00
bbb5e58583 doc: Fix filename 2016-07-30 20:58:04 +02:00
6f71dc517f doc: Remove comment 2016-07-30 20:57:36 +02:00
9354ae003a doc: Fix bullet-list markup 2016-07-30 20:56:57 +02:00
4e230ecc61 doc: Update version 2016-07-30 20:55:18 +02:00
0c5674dd47 Merge pull request #525 from matthiasbeyer/update-doc
Update doc
2016-07-14 21:11:30 +02:00
e250059390 doc: Add file for tagging module documentation 2016-07-13 18:34:58 +02:00
f36851786a doc: Add description for linking module 2016-07-13 18:34:00 +02:00
f8b1d48307 doc: Add user documentation for imag-diary 2016-07-13 18:27:36 +02:00
45d41748f6 doc: Add store module documentation 2016-07-12 17:12:16 +02:00
51432eaf39 Add example how to use imag-counter 2016-07-12 17:00:02 +02:00
9337a14cdd Update all version strings: 0.1.0 -> 0.2.0 2016-07-12 11:51:20 +02:00
ed4b198359 doc: Fix version string 2016-07-08 20:58:47 +02:00
9283d964d5 doc: Add most basic section structure for module files 2016-07-08 20:51:45 +02:00
a8206b8f19 doc: Remove comment markers 2016-07-08 20:48:41 +02:00
fafc8418df doc: Remove utility documentation, as the user should never see this 2016-07-08 20:43:32 +02:00
39c1b30e6f doc: Add module file for view 2016-07-08 20:43:32 +02:00
0b1356a104 doc: Rewrite initial text for module section 2016-07-08 20:43:25 +02:00
1c0fc5a0a7 doc: Remove file on tagging 2016-07-08 20:43:25 +02:00
5a229a24b0 doc: Add module files: {link, ref} 2016-07-08 20:43:25 +02:00
f81e47ceb2 doc: Rewrite linking chapter 2016-07-08 20:43:20 +02:00
7a8432123b doc: Rewrite "The Store" chapter 2016-07-08 20:43:12 +02:00
28a9c5ffc9 doc: Rewrote intro 2016-07-08 20:43:06 +02:00
12cb61cd8b doc: Rename documentation files for modules 2016-07-08 17:42:47 +02:00
d8c4d55312 doc: Add chapter on technical details 2016-07-08 17:39:19 +02:00
d0a5beae9a doc: Remove library documentation files 2016-07-08 17:37:58 +02:00
b0de23bfbf doc: Rename document, set new date 2016-07-08 17:37:47 +02:00
9fa362c22c Add initial proposal for notes module 2016-03-25 16:30:12 +01:00
f253931bb7 doc: Adjust documentation to match implementation 2016-03-16 16:46:54 +01:00
4dc1140149 doc: Add hook aspect definition 2016-03-16 16:46:52 +01:00
c9bca51273 doc: Add documentation for the Hook system 2016-03-16 16:46:51 +01:00
8d234440b5 doc: imag-counter 2016-03-15 15:01:10 +01:00
20201d2358 Merge pull request #210 from matthiasbeyer/doc/libimagutil
Doc/libimagutil
2016-03-07 17:18:50 +01:00
637faf2d66 Merge pull request #219 from matthiasbeyer/doc/add-module-files
Add module files for several modules
2016-03-07 17:14:30 +01:00
a02a0f2fde Merge pull request #167 from matthiasbeyer/doc/linking
doc: Add chapter on linking
2016-03-06 11:53:18 +01:00
fc46f1a8df doc: imag:// prefix should be optional 2016-03-06 11:18:31 +01:00
5b034dc37b doc: Add liblink specification 2016-03-06 11:18:01 +01:00
4b4809571a doc: Add paragraph in section for linking internal content 2016-03-06 11:17:30 +01:00
fc7a86ba50 doc: Add initial paragraph 2016-03-06 11:17:30 +01:00
a51b68e838 doc: Add chapter on linking 2016-03-06 11:17:26 +01:00
7ff1995acc Move files to new filenames, so we have alphabetical ordering 2016-03-02 17:32:24 +01:00
3c30cecee8 Add module files for several modules
Rename modules, so we have alphabetical order for the modules, which is
way nicer than the current order.

The following modules are added:

    - borrow
    - counter
    - cuecards
    - dairy
    - ledger
    - password
    - weather

Plus, this commit adds an utility module file, where the utility modules
are described
2016-02-29 20:21:51 +01:00
22b41004ae doc: Remove file for "libimagmodule", as this was removed 2016-02-21 20:33:36 +01:00
babb7b7055 doc: libimagutil: Add documentation of the generate_variants() util 2016-02-21 20:27:24 +01:00
6baa3c7f38 doc: libimagutil: Add error-tracing utility documentation 2016-02-21 20:27:23 +01:00
3e18a6df6c doc: libimagutil: Add kv-split documentation 2016-02-21 20:26:56 +01:00
c25f32fd85 Add chapter on libtag 2016-02-05 11:55:49 +01:00
b4d88c72bf doc: Add section store/tagging 2016-02-05 11:55:48 +01:00
Marcel Müller
dbbda9bf5d
Explain futureproofing store files 2016-01-23 19:01:29 +01:00
Homu
2c1fa1a92a Auto merge of #89 - matthiasbeyer:libimagrt-init, r=matthiasbeyer
Libimagrt init

Initial code for `libimagrt`.
2016-01-21 07:59:38 -08:00
e44e413b08 Clear the "imag.content" key definition. 2016-01-19 17:34:52 +01:00
6183efedbc Fix: Remove "mime"-key in header
We don't need this one, actually.
2016-01-19 17:34:52 +01:00
9d9efa76ea Update example 2016-01-19 17:34:52 +01:00
adaa6b69ec Clearify content section format (as seen by the store library) 2016-01-19 17:34:52 +01:00
cafc6dbadf Rewrite chapter on header contents 2016-01-19 17:34:52 +01:00
88930da796 Add fields in the header section "imag" 2016-01-19 16:51:41 +01:00
4ce693c05f Add paragraph on store path links 2016-01-19 16:49:14 +01:00
78d25ebad7 Rewrite part on store path format 2016-01-19 16:49:14 +01:00
71dc86d2e7 doc: Add more paths where we search for config 2016-01-18 19:22:14 +01:00
Homu
469bdd1d94 Auto merge of #99 - TheNeikos:add-libstore, r=matthiasbeyer
Add libimagstore

Alright, do check the file and feel free to post comments/ask questions
2016-01-17 23:44:27 +09:00
Marcel Müller
2f99f5561a
Remove Store caching from docs 2016-01-17 15:37:07 +01:00
Marcel Müller
b06621c6bd
Add doc for mutators entry has to export 2016-01-17 15:37:02 +01:00
Marcel Müller
49184c10a3
Add FileLockEntry to doc table 2016-01-17 15:36:41 +01:00
4857456d0f doc: Add introduction 2016-01-14 17:00:49 +01:00
9d265159ee doc: Add initial version of lib-store documentation/definition 2016-01-12 19:21:41 +01:00
Homu
ec6ac7794f Auto merge of #90 - matthiasbeyer:doc-define-store-format, r=matthiasbeyer
Define file format

Related to #76.

@TheNeikos , @neithernut Would like to hear suggestions.
2016-01-13 01:52:52 +09:00
535c2f4d4c Modules store data not in a subsection of the "imag" section 2016-01-12 17:09:04 +01:00
ddb3a2717a doc: store: fileformat: Add example 2016-01-12 13:07:49 +01:00
6141c8499d doc: Add definition of modules 2016-01-11 18:15:22 +01:00
c8f0b26577 doc: rt: Add chapter on configuration file 2016-01-11 18:15:22 +01:00
d636339abe doc: define runtime library 2016-01-11 17:22:36 +01:00
e92cd8d558 State that modules can store data in the "imag" part of the header 2016-01-11 09:29:13 +01:00
a377a9a031 Add file organization spec 2016-01-10 18:07:15 +01:00
363d611522 Define file format 2016-01-10 18:07:15 +01:00
7c1e1fb8d5 Add initial content for libutil 2016-01-10 17:46:40 +01:00
906c4cbd00 There is no libcore, there is only libutil 2016-01-10 17:44:17 +01:00
fdc63e0194 Remove chapter on commands, should be included in chapter on modules 2016-01-09 21:12:53 +01:00
86ad93a5e9 Rewrite structure 2016-01-09 21:12:00 +01:00
a2c93f9fe9 Comment out some modules/commands
These are not that relevant for the first iteration.
Keep quite a lot others, as we need to consider different use-cases for
the store to be able to define a module-independent store format and so
on.
2016-01-08 21:12:13 +01:00
f25c4665c1 Fix filename 2016-01-08 21:08:42 +01:00
7e2602f9f9 Add basic file structure 2016-01-08 18:28:31 +01:00
fd541c3270 Add configuration for pandoc-crossref 2016-01-08 13:12:55 +01:00
3ea9721184 Add default doc setup 2016-01-08 13:11:04 +01:00