Go to file
2019-09-21 21:29:33 +03:00
benches melib: remove BackendOpGenerator 2019-07-18 20:14:14 +03:00
debug_printer Fix warnings, lints, and 2018 errors 2019-06-18 21:14:14 +03:00
melib Turn off debug tracing prints in stderr by default 2019-09-21 21:29:33 +03:00
scripts scripts: remove auto-rustfmt from pre-commit hook 2019-06-10 19:40:33 +03:00
src add priority and info to jobs and workers 2019-09-15 13:21:14 +03:00
testing Bump version to 0.3.0 2019-09-16 16:44:04 +03:00
text_processing Bump version to 0.3.0 2019-09-16 16:44:04 +03:00
ui ui: add log on child waiting error 2019-09-20 10:26:08 +03:00
.gdbinit add experimental gdb debug lib 2019-06-10 19:40:50 +03:00
.gitignore mailbox: add threads 2019-06-10 19:11:47 +03:00
Cargo.toml Turn off debug tracing prints in stderr by default 2019-09-21 21:29:33 +03:00
COPYING mailbox: add threads 2019-06-10 19:11:47 +03:00
Makefile add Makefile for installation 2019-09-16 16:41:22 +03:00
meli.1 update manual page and add meli.conf(5) 2019-09-16 16:40:29 +03:00
meli.conf.5 update manual page and add meli.conf(5) 2019-09-16 16:40:29 +03:00
README Turn off debug tracing prints in stderr by default 2019-09-21 21:29:33 +03:00
rustfmt.toml Run rustfmt 2019-06-10 19:40:39 +03:00
sample-config update manual page and add meli.conf(5) 2019-09-16 16:40:29 +03:00

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.

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` or in a development profile in Cargo.toml. The logs
are printed in stderr, thus you can run meli with a redirection (i.e `2> log`)

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