From 13afbbf10f3b8506b4321d6026cacdea5f775215 Mon Sep 17 00:00:00 2001 From: Nick Gerace Date: Sat, 10 Oct 2020 22:57:12 -0400 Subject: Add eyre for simple backtrace reporting Add eyre for simple backtrace reporting. Since gfold relies on speed and efficiency, and sports a relatively small codebase, eyre provides a simple backtrace report when an error is encountered. Specifically, the filename and line are the most important parts. Unrelated, add a cargo doc command to the release Make target. Adjust existing docs comments to match style. Change some private definitions to be public. --- Makefile | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 30b9645..a7f814e 100644 --- a/Makefile +++ b/Makefile @@ -49,12 +49,14 @@ fixme: FIXME $(MAKEPATH) release: - @printf "Change version at the following locations...\n" + @printf "[1] Change version at the following locations...\n" @printf " Makefile: $(shell grep $(VERSION) $(MAKEPATH)/Makefile)\n" @printf " README.md: $(shell grep $(VERSION) $(MAKEPATH)/README.md)\n" @printf " CHANGELOG.md: $(shell grep $(VERSION) $(MAKEPATH)/CHANGELOG.md)\n" @printf " Cargo.toml: $(shell grep $(VERSION) $(MAKEPATH)/Cargo.toml)\n" - @printf "Uncomment the unreleased string in CHANGELOG.md...\n" + @printf "[2] Uncomment the unreleased string in CHANGELOG.md...\n" @printf " \n" - @printf "Then, run the following command...\n" + @printf "[3] Run the following command to check documentation...\n" + @printf " cargo doc --open\n" + @printf "[4] Then, run the following command...\n" @printf " time make build-release\n" -- cgit v1.2.3