Browse Source

Add info about debug logs in README and Cargo.toml

tags/pre-alpha-0.3.1
Manos Pitsidianakis 1 year ago
parent
commit
8c78f118e4
WARNING! Although there is a key with this ID in the database it does not verify this commit! This commit is SUSPICIOUS. GPG Key ID: 73627C2F690DF710
2 changed files with 14 additions and 7 deletions
  1. +7
    -3
      Cargo.toml
  2. +7
    -4
      README

+ 7
- 3
Cargo.toml View File

@ -15,6 +15,9 @@ signal-hook = "0.1.10"
nix = "*"
melib = { path = "melib", version = "*" }
ui = { path = "ui", version = "*" }
#enable for debug tracing logs
#melib = { path = "melib", version = "*", features=["debug-tracing",] }
#ui = { path = "ui", version = "*", features=["debug-tracing",] }
[profile.release]
lto = true
@ -25,6 +28,7 @@ members = ["melib", "ui", "debug_printer", "testing", "text_processing"]
[features]
default = []
# Print tracing logs as meli runs
debug-tracing = []
# Print tracing logs as meli runs in stderr
#
# enable for debug tracing logs
# debug-tracing = []

+ 7
- 4
README View File

@ -54,10 +54,13 @@ DEVELOPMENT
Development builds can be built and/or run with
# cargo build
# cargo run 2> debug.log
# cargo run
The debug logs can be disabled by setting debug-assertions to false in the
development profile in Cargo.toml. In the future debug logs will be a feature.
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
======
@ -68,7 +71,7 @@ meli by default looks for a configuration file in this location:
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 2> debug.log
# MELI_CONFIG=./test_config cargo run
TESTING
=======

Loading…
Cancel
Save