diff options
Diffstat (limited to 'vendor/gimli/README.md')
| -rw-r--r-- | vendor/gimli/README.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/vendor/gimli/README.md b/vendor/gimli/README.md new file mode 100644 index 000000000..56cee2531 --- /dev/null +++ b/vendor/gimli/README.md @@ -0,0 +1,78 @@ +# `gimli` + +[ ](https://crates.io/crates/gimli) +[](https://docs.rs/gimli/) +[](https://github.com/gimli-rs/gimli/actions) +[](https://coveralls.io/github/gimli-rs/gimli?branch=master) + +`gimli` is a blazing fast library for consuming the +[DWARF debugging format](http://dwarfstd.org/). + +* **Zero copy:** everything is just a reference to the original input buffer. No + copies of the input data get made. + +* **Lazy:** you can iterate compilation units without parsing their + contents. Parse only as many debugging information entry (DIE) trees as you + iterate over. `gimli` also uses `DW_AT_sibling` references to avoid parsing a + DIE's children to find its next sibling, when possible. + +* **Cross-platform:** `gimli` makes no assumptions about what kind of object + file you're working with. The flipside to that is that it's up to you to + provide an ELF loader on Linux or Mach-O loader on macOS. + + * 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`. + +## Install + +Add this to your `Cargo.toml`: + +```toml +[dependencies] +gimli = "0.26.1" +``` + +The minimum supported Rust version is 1.42.0. + +## Documentation + +* [Documentation on docs.rs](https://docs.rs/gimli/) + +* Example programs: + + * [A simple `.debug_info` parser](./examples/simple.rs) + + * [A simple `.debug_line` parser](./examples/simple_line.rs) + + * [A `dwarfdump` clone](./examples/dwarfdump.rs) + + * [An `addr2line` clone](https://github.com/gimli-rs/addr2line) + + * [`ddbug`](https://github.com/philipc/ddbug), a utility giving insight into + code generation by making debugging information readable. + + * [`dwprod`](https://github.com/fitzgen/dwprod), a tiny utility to list the + 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 + integrity of some DWARF and its references between sections and compilation + units. + +## License + +Licensed under either of + + * Apache License, Version 2.0 ([`LICENSE-APACHE`](./LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([`LICENSE-MIT`](./LICENSE-MIT) or https://opensource.org/licenses/MIT) + +at your option. + +## Contribution + +See [CONTRIBUTING.md](./CONTRIBUTING.md) for hacking. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. |