build: Reorganize the workspace (#266)

Moves the main `symbolic` library into a workspace member and
reorganizes all examples as workspace members. The main readme is
temporarily duplicated until the new version is published.

Author: jan-auer

.gitignore

@@ -4,8 +4,7 @@
 # Rust
 target/
 **/*.rs.bk
-# Only ignore the library's lockfile, not for the CABI
-/Cargo.lock
+Cargo.lock
 
 # Python
 *.pyc

.gitmodules

@@ -1,7 +1,7 @@
 [submodule "minidump/third_party/breakpad"]
-	path = minidump/third_party/breakpad
+	path = symbolic-minidump/third_party/breakpad
 	url = https://github.com/getsentry/breakpad
 	shallow = true
 [submodule "minidump/third_party/lss"]
-	path = minidump/third_party/lss
+	path = symbolic-minidump/third_party/lss
 	url = https://github.com/getsentry/linux-syscall-support

Cargo.toml

@@ -1,80 +1,9 @@
-[package]
-name = "symbolic"
-version = "7.5.0"
-license = "MIT"
-authors = [
-    "Armin Ronacher <[email protected]>",
-    "Jan Michael Auer <[email protected]>",
-]
-documentation = "https://docs.rs/symbolic"
-homepage = "https://github.com/getsentry/symbolic"
-repository = "https://github.com/getsentry/symbolic"
-readme = "README.md"
-description = """
-A library to symbolicate and process stack traces from native applications,
-minidumps, Unreal Engine 4, minified JavaScripts or ProGuard optimized Android apps.
-"""
-edition = "2018"
-autoexamples = true
-
-include = [
-    "/src/**/*.rs",
-    "/*.toml",
-    "/.gitmodules",
-    "/LICENSE",
-    "/README.md",
-]
-
-[package.metadata.docs.rs]
-all-features = true
-
 [workspace]
+members = [
+    "symbolic*",
+    "examples/*",
+]
 
-[features]
-default = ["debuginfo"]
-common-serde = ["symbolic-common/serde"]
-debuginfo = ["symbolic-debuginfo"]
-debuginfo-serde = ["debuginfo", "common-serde"]
-demangle = ["symbolic-demangle"]
-minidump = ["symbolic-minidump", "debuginfo"]
-minidump-serde = ["minidump", "debuginfo-serde", "symbolic-minidump/serde"]
-proguard = ["symbolic-proguard"]
-sourcemap = ["symbolic-sourcemap"]
-symcache = ["symbolic-symcache", "debuginfo"]
-unreal = ["symbolic-unreal"]
-unreal-serde = ["unreal", "common-serde", "symbolic-unreal/serde"]
-
-[dependencies]
-symbolic-common = { version = "7.5.0", path = "common" }
-symbolic-debuginfo = { version = "7.5.0", path = "debuginfo", optional = true }
-symbolic-demangle = { version = "7.5.0", path = "demangle", optional = true }
-symbolic-minidump = { version = "7.5.0", path = "minidump", optional = true }
-symbolic-proguard = { version = "7.5.0", path = "proguard", optional = true }
-symbolic-sourcemap = { version = "7.5.0", path = "sourcemap", optional = true }
-symbolic-symcache = { version = "7.5.0", path = "symcache", optional = true }
-symbolic-unreal = { version = "7.5.0", path = "unreal", optional = true }
-
-[dev-dependencies]
-clap = "2.33.0"
-failure = "0.1.7"
-walkdir = "2.3.1"
-
-[[example]]
-name = "addr2line"
-required-features = ["demangle"]
-
-[[example]]
-name = "dump_cfi"
-required-features = ["minidump"]
-
-[[example]]
-name = "minidump_stackwalk"
-required-features = ["minidump", "symcache", "demangle"]
-
-[[example]]
-name = "symcache_debug"
-required-features = ["symcache", "demangle"]
-
-[[example]]
-name = "unreal_engine_crash"
-required-features = ["unreal"]
+[profile.release]
+debug = true
+lto = true

Makefile

@@ -8,7 +8,6 @@ check: style lint
 
 clean:
 	cargo clean
-	cargo clean --manifest-path cabi/Cargo.toml
 	rm -rf .venv
 .PHONY: clean
 
@@ -36,7 +35,7 @@ test: test-rust test-python
 .PHONY: test
 
 test-rust:
-	cargo test --all --all-features
+	cargo test --workspace --all-features
 .PHONY: test-rust
 
 test-python: .venv/bin/python
@@ -52,8 +51,7 @@ style: style-rust style-python
 
 style-rust:
 	@rustup component add rustfmt --toolchain stable 2> /dev/null
-	cargo +stable fmt -- --check
-	cd cabi && cargo +stable fmt -- --check
+	cargo +stable fmt --all -- --check
 .PHONY: style-rust
 
 style-python: .venv/bin/python
@@ -67,7 +65,7 @@ lint: lint-rust lint-python
 
 lint-rust:
 	@rustup component add clippy --toolchain stable 2> /dev/null
-	cargo +stable clippy --all-features --all --tests --examples -- -D clippy::all
+	cargo +stable clippy --all-features --workspace --tests --examples -- -D clippy::all
 .PHONY: lint-rust
 
 lint-python: .venv/bin/python
@@ -82,8 +80,7 @@ format: format-rust format-python
 
 format-rust:
 	@rustup component add rustfmt --toolchain stable 2> /dev/null
-	cargo +stable fmt
-	cd cabi && cargo +stable fmt
+	cargo +stable fmt --all
 .PHONY: format-rust
 
 format-python: .venv/bin/python

README.md

@@ -40,31 +40,7 @@ Symbolic provides the following functionality:
 
 ## Rust Usage
 
-Add `symbolic` as a dependency to your `Cargo.toml`. You will most likely want to activate some of
-the features:
-
-- **`debuginfo`** (default): Contains support for various object file formats and debugging
-  information. Currently, this comprises MachO and ELF (with DWARF debugging), PE and PDB, as well
-  as Breakpad symbols.
-- **`demangle`**: Demangling for Rust, C++, Swift and Objective C symbols. This feature requires a
-  C++14 compiler on the PATH.
-- **`minidump`**: Rust bindings for the Breakpad Minidump processor. Additionally, this includes
-  facilities to extract stack unwinding information (sometimes called CFI) from object files. This
-  feature requires a C++11 compiler on the PATH.
-- **`proguard`**: Processing of Proguard mapping files to look up mangled Java function paths.
-- **`sourcemap`**: Processing and expansion of JavaScript source maps, as well as lookups for
-  minified function names.
-- **`symcache`**: An optimized, platform-independent storage for common debugging information. This
-  allows blazing fast symbolication of instruction addresses to function names and file locations.
-- **`unreal`**: Processing of Unreal Engine 4 crash reports.
-
-There are also alternate versions for some of the above features that additionally add
-implementations for `serde::{Deserialize, Serialize}` on suitable types:
-
-- **`common-serde`**
-- **`debuginfo-serde`**
-- **`minidump-serde`**
-- **`unreal-serde`**
+The Rust crates are published to [Crates.io](https://crates.io/crates/symbolic) and documentation is available on [docs.rs](https://docs.rs/symbolic/latest/symbolic/).
 
 ## Python Usage