Skip to main content

gsym/
docs.rs

1//! Long-form guides.
2//!
3//! - [`symbolication`]: which address to ask about, how to read the frames that
4//!   come back, and what a lookup costs.
5//! - [`cookbook`]: worked examples for each part of the public API.
6#![cfg_attr(
7    feature = "convert",
8    doc = " - [`conversion`]: building GSYM from Linux ELF files and their DWARF."
9)]
10//! - [`mod@format`]: the on-disk format, for debugging files and comparing
11//!   against `llvm-gsymutil`.
12
13#[doc = include_str!("../docs/symbolication.md")]
14pub mod symbolication {}
15
16#[doc = include_str!("../docs/cookbook.md")]
17pub mod cookbook {}
18
19#[cfg(feature = "convert")]
20#[cfg_attr(docsrs, doc(cfg(feature = "convert")))]
21#[doc = include_str!("../docs/cookbook-convert.md")]
22pub mod conversion {}
23
24#[doc = include_str!("../docs/format.md")]
25pub mod format {}