Move examples to a separate crate (#671)

gimli-rs · Aug 8, 2023 · cfac938 · cfac938
1 parent 1c3d19b
commit cfac938
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 34 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -37,13 +37,13 @@ jobs:
     - name: Run dwarfdump (macos)
       if: matrix.os == 'macOS-latest'
       run: |
-        cargo run --example dwarfdump -- \
+        cargo run --bin dwarfdump -- \
             $(find ./target/debug -type f | grep DWARF | grep gimli | head -n 1) \
             > /dev/null
     - name: Run dwarfdump (linux)
       if: matrix.os == 'ubuntu-latest'
       run: |
-        cargo run --example dwarfdump -- \
+        cargo run --bin dwarfdump -- \
             $(find ./target/debug -type f -perm -100 | grep gimli | head -n 1) \
             > /dev/null
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -8,7 +8,6 @@ edition = "2018"
 include = [
     "/CHANGELOG.md",
     "/Cargo.toml",
-    "/examples",
     "/LICENSE-APACHE",
     "/LICENSE-MIT",
     "/README.md",
@@ -31,15 +30,7 @@ alloc = { version = "1.0.0", optional = true, package = "rustc-std-workspace-all
 compiler_builtins = { version = "0.1.2", optional = true }
 
 [dev-dependencies]
-crossbeam = "0.8"
-getopts = "0.2"
-memmap2 = "0.6.1"
-num_cpus = "1"
-object = { version = "0.30.0", features = ["wasm"] }
-rayon = "1.0"
-regex = "1"
 test-assembler = "0.1.3"
-typed-arena = "2"
 
 [features]
 read-core = []
@@ -61,18 +52,7 @@ debug = true
 codegen-units = 1
 split-debuginfo = "packed"
 
-[[example]]
-name = "simple"
-required-features = ["read"]
-
-[[example]]
-name = "simple_line"
-required-features = ["read"]
-
-[[example]]
-name = "dwarfdump"
-required-features = ["read", "std"]
-
-[[example]]
-name = "dwarf-validate"
-required-features = ["read", "std"]
+[workspace]
+members = ["crates/examples"]
+default-members = [".", "crates/examples"]
+resolver = "2"
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@
 
   * Unsure which object file parser to use? Try the cross-platform
   [`object`](https://github.com/gimli-rs/object) crate. See the
-  [`examples/`](./examples) directory for usage with `gimli`.
+  [`gimli-examples`](./crates/examples/src/bin) crate for usage with `gimli`.
 
 ## Install
 
@@ -41,11 +41,11 @@ The minimum supported Rust version is 1.42.0.
 
 * Example programs:
 
-  * [A simple `.debug_info` parser](./examples/simple.rs)
+  * [A simple `.debug_info` parser](./crates/examples/src/bin/simple.rs)
 
-  * [A simple `.debug_line` parser](./examples/simple_line.rs)
+  * [A simple `.debug_line` parser](./crates/examples/src/bin/simple_line.rs)
 
-  * [A `dwarfdump` clone](./examples/dwarfdump.rs)
+  * [A `dwarfdump` clone](./crates/examples/src/bin/dwarfdump.rs)
 
   * [An `addr2line` clone](https://github.com/gimli-rs/addr2line)
 
@@ -56,7 +56,7 @@ The minimum supported Rust version is 1.42.0.
     compilers used to create each compilation unit within a shared library or
     executable (via `DW_AT_producer`).
 
-  * [`dwarf-validate`](./examples/dwarf-validate.rs), a program to validate the
+  * [`dwarf-validate`](./crates/examples/src/bin/dwarf-validate.rs), a program to validate the
     integrity of some DWARF and its references between sections and compilation
     units.
 

diff --git a/crates/examples/Cargo.toml b/crates/examples/Cargo.toml
@@ -0,0 +1,37 @@
+[package]
+name = "gimli-examples"
+version = "0.0.0"
+edition = "2018"
+
+[dependencies]
+gimli = { path = "../..", default-features = false }
+crossbeam = "0.8"
+fallible-iterator = { version = "0.2.0", default-features = false }
+getopts = "0.2"
+memmap2 = "0.6.1"
+num_cpus = "1"
+object = { version = "0.30.0", features = ["wasm"] }
+rayon = "1.0"
+regex = "1"
+typed-arena = "2"
+
+[features]
+read = ["gimli/read"]
+std = ["gimli/std"]
+default = ["read", "std"]
+
+[[bin]]
+name = "simple"
+required-features = ["read"]
+
+[[bin]]
+name = "simple_line"
+required-features = ["read"]
+
+[[bin]]
+name = "dwarfdump"
+required-features = ["read", "std"]
+
+[[bin]]
+name = "dwarf-validate"
+required-features = ["read", "std"]
diff --git a/examples/dwarf-validate.rs → crates/examples/src/bin/dwarf-validate.rs b/examples/dwarf-validate.rs → crates/examples/src/bin/dwarf-validate.rs
diff --git a/examples/dwarfdump.rs → crates/examples/src/bin/dwarfdump.rs b/examples/dwarfdump.rs → crates/examples/src/bin/dwarfdump.rs
diff --git a/examples/simple.rs → crates/examples/src/bin/simple.rs b/examples/simple.rs → crates/examples/src/bin/simple.rs
diff --git a/examples/simple_line.rs → crates/examples/src/bin/simple_line.rs b/examples/simple_line.rs → crates/examples/src/bin/simple_line.rs
diff --git a/src/read/mod.rs b/src/read/mod.rs
@@ -41,10 +41,10 @@
 //!
 //! Full example programs:
 //!
-//!   * [A simple parser](https://github.com/gimli-rs/gimli/blob/master/examples/simple.rs)
+//!   * [A simple parser](https://github.com/gimli-rs/gimli/blob/master/crates/examples/src/bin/simple.rs)
 //!
 //!   * [A `dwarfdump`
-//!     clone](https://github.com/gimli-rs/gimli/blob/master/examples/dwarfdump.rs)
+//!     clone](https://github.com/gimli-rs/gimli/blob/master/crates/examples/src/bin/dwarfdump.rs)
 //!
 //!   * [An `addr2line` clone](https://github.com/gimli-rs/addr2line)
 //!
@@ -55,7 +55,7 @@
 //!     compilers used to create each compilation unit within a shared library or
 //!     executable (via `DW_AT_producer`)
 //!
-//!   * [`dwarf-validate`](https://github.com/gimli-rs/gimli/blob/master/examples/dwarf-validate.rs),
+//!   * [`dwarf-validate`](https://github.com/gimli-rs/gimli/blob/master/crates/examples/src/bin/dwarf-validate.rs),
 //!     a program to validate the integrity of some DWARF and its references
 //!     between sections and compilation units.
 //!