summaryrefslogtreecommitdiff
path: root/Makefile
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2020-10-10 22:57:12 -0400
committerNick Gerace <nickagerace@gmail.com>2020-10-10 23:04:31 -0400
commit13afbbf10f3b8506b4321d6026cacdea5f775215 (patch)
treed33e28e06de67981238a8ccab47f795c588e5e8b /Makefile
parentfe195fffdc878a94c62fb97bc64fc5a0b834e697 (diff)
downloadgfold-13afbbf10f3b8506b4321d6026cacdea5f775215.zip
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.
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile8
1 files changed, 5 insertions, 3 deletions
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 " <!--The latest version contains all changes.-->\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"