From 277c5919a41d9f86e928789d169ff71a5a35abfb Mon Sep 17 00:00:00 2001 From: Philippe Normand Date: Mon, 17 Jun 2019 12:42:08 +0100 Subject: [PATCH] Move examples out of the library There's no need for sub-crates actually. We can simply flags the examples as such in the build manifest. Fixes #2 --- Cargo.toml | 22 +++++++++++++++++++++- README.md | 6 +++--- {src/bin => examples}/dump.rs | 0 {src/bin => examples}/flow.rs | 0 {src/bin => examples}/latency.rs | 0 {src/bin => examples}/omx-perf.rs | 0 {src/bin => examples}/track-frames-omx.rs | 0 {src/bin => examples}/ts-diff.rs | 0 8 files changed, 24 insertions(+), 4 deletions(-) rename {src/bin => examples}/dump.rs (100%) rename {src/bin => examples}/flow.rs (100%) rename {src/bin => examples}/latency.rs (100%) rename {src/bin => examples}/omx-perf.rs (100%) rename {src/bin => examples}/track-frames-omx.rs (100%) rename {src/bin => examples}/ts-diff.rs (100%) diff --git a/Cargo.toml b/Cargo.toml index aebb201..6746547 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,8 +9,28 @@ itertools = "0.7" gstreamer = "0.12" regex = "1.0" lazy_static = "1.0" + +[[example]] +name = "dump" + +[[example]] +name = "flow" + +[[example]] +name = "latency" + +[[example]] +name = "omx-perf" + +[[example]] +name = "track-frames-omx" + +[[example]] +name = "ts-diff" + +[dev-dependencies] structopt = "0.2" structopt-derive = "0.2" colored = "1.6" -failure = "0.1.5" gnuplot = "0.0.30" +failure = "0.1.5" diff --git a/README.md b/README.md index feb9035..3829377 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ # gst-log-parser [![Build Status](https://travis-ci.org/gdesmott/gst-log-parser.svg?branch=master)](https://travis-ci.org/gdesmott/gst-log-parser) Simple Rust library to parse GStreamer logs. -See [the examples](https://github.com/gdesmott/gst-log-parser/tree/master/src/bin) demonstrating how to use it. +See [the examples](https://github.com/gdesmott/gst-log-parser/tree/master/examples) demonstrating how to use it. ## Quick start - [Install Rust](https://www.rust-lang.org/en-US/install.html) if needed - `cargo build --release` -- Parsing tools can be executed using `cargo run --release --bin` and are also available in `target/release/` +- Parsing tools can be executed using `cargo run --release --example` and are also available in `target/release/examples/` ## Tools -`src/bin` contains a few log parsers. They can be used as examples demonstrating how to use this crate +`examples` contains a few log parsers. They can be used as examples demonstrating how to use this crate but also should be useful when debugging specific issues. ### flow diff --git a/src/bin/dump.rs b/examples/dump.rs similarity index 100% rename from src/bin/dump.rs rename to examples/dump.rs diff --git a/src/bin/flow.rs b/examples/flow.rs similarity index 100% rename from src/bin/flow.rs rename to examples/flow.rs diff --git a/src/bin/latency.rs b/examples/latency.rs similarity index 100% rename from src/bin/latency.rs rename to examples/latency.rs diff --git a/src/bin/omx-perf.rs b/examples/omx-perf.rs similarity index 100% rename from src/bin/omx-perf.rs rename to examples/omx-perf.rs diff --git a/src/bin/track-frames-omx.rs b/examples/track-frames-omx.rs similarity index 100% rename from src/bin/track-frames-omx.rs rename to examples/track-frames-omx.rs diff --git a/src/bin/ts-diff.rs b/examples/ts-diff.rs similarity index 100% rename from src/bin/ts-diff.rs rename to examples/ts-diff.rs