mirror of https://git.meli.delivery/meli/meli
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
17a0f31b3e
UIEvent::StartupCheck was meant to notify the UI that a folder had made progress and polling its async worker would return a Result<Vec<Envelope>>. However the StartupCheck was received by MailListing components which called account.status() which did the polling. That means that if the polling got back results, the listing would have to call account.status() again to show them. This is a problem in configurations with only one account because there aren't any other sources of event to force the listing to recheck account.status() A new event UIEvent::WorkerProgress will do the job of notifying an Account to poll its workers and the account will send a startupcheck if it has made progress. That way the refresh progress is as follows: Worker thread sends WorkerProgress event -> State calls appropriate account's account.status() method -> account polls workers, and if there are new results send StartupCheck events -> State passes StartupCheck events to components -> Listings update themselves when they receive the event |
5 years ago | |
|---|---|---|
| benches | ||
| debug_printer | ||
| melib | ||
| scripts | ||
| src | ||
| testing | ||
| tests | ||
| text_processing | ||
| ui | ||
| .gdbinit | ||
| .gitignore | ||
| COPYING | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Makefile | ||
| README | ||
| meli.1 | ||
| meli.conf.5 | ||
| rustfmt.toml | ||
| sample-config | ||
README
__
__/ \__
/ \__/ \__ .
\__/ \__/ \ , _ , _ ___ │ '
/ \__ \__/ │' `│ `┒ .' ` │ │
\__/ \__/ \ │ │ │ |────' │ │
\__/ \__/ │ / `.___, /\__ /
\__/
,-.
\_/
terminal mail user agent {|||)<
/ \
`-'
DOCUMENTATION
=============
After installing meli, see meli(1) and meli.conf(5) for documentation.
BUILDING
========
meli requires rust 1.39 and rust's package manager, Cargo. Information on how
to get it on your system can be found here:
https://doc.rust-lang.org/cargo/getting-started/installation.html
With Cargo available, the project can be built with
# make
The resulting binary will then be found under target/release/meli
Run:
# make install
to install the binary and man pages. This requires root, so I suggest you override the default paths and install it in your $HOME:
# make PREFIX=$HOME/.local install
See meli(1) and meli.conf(5) for documentation.
You can build and run meli with one command:
# cargo run --release
While the project is in early development, meli will only be developed for the
linux kernel and respected linux distributions. Support for more UNIX-like OSes
is on the roadmap.
BUILDING IN DEBIAN
==================
Building with Debian's packaged cargo might require the installation of these
two packages: librust-openssl-sys-dev and librust-libdbus-sys-dev
BUILDING WITH NOTMUCH
=====================
To use the optional notmuch backend feature, you must have libnotmuch installed in your system. In Debian-like systems, install the "libnotmuch" package.
To build with notmuch support, prepend the environment variable "MELI_FEATURES='notmuch'" to your make invocation:
# MELI_FEATURES="notmuch" make
or if building directly with cargo, use the flag '--features="notmuch"'.
BUILDING WITH JMAP
=====================
To build with JMAP support, prepend the environment variable "MELI_FEATURES='jmap'" to your make invocation:
# MELI_FEATURES="jmap" make
or if building directly with cargo, use the flag '--features="jmap"'.
DEVELOPMENT
===========
Development builds can be built and/or run with
# cargo build
# cargo run
There is a debug/tracing log feature that can be enabled by using the flag
`--feature debug-tracing` after uncommenting the features in `Cargo.toml`. The logs
are printed in stderr, thus you can run meli with a redirection (i.e `2> log`)
Code style follows the default rustfmt profile.
CONFIG
======
meli by default looks for a configuration file in this location:
# $XDG_CONFIG_HOME/meli/config
You can run meli with arbitrary configuration files by setting the MELI_CONFIG
environment variable to their locations, ie:
# MELI_CONFIG=./test_config cargo run
TESTING
=======
How to run specific tests:
# cargo test -p {melib, ui, meli} (-- --nocapture) (--test test_name)
PROFILING
=========
# perf record -g target/debug/bin
# perf script | stackcollapse-perf | rust-unmangle | flamegraph > perf.svg