-
-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
KISS build docs #102
base: freeze-feat-andreas
Are you sure you want to change the base?
KISS build docs #102
Conversation
Fixes waycrate#101 Why? - no build.rs that is invoked on _any_ `cargo build/run` - no extra dev dependency - no intermediate `docs/*.out` files - 3 lines of bash instead - maximum gzip compression (-9/--best) - docs will be built only when needed, i.e. on `make docs` or `make install` To quickly check: ```sh make TARGET_DIR=/tmp/wayshot MAN{1,7}_DIR=/tmp/wayshot install ```
Shows exactly what is going on. Also fixes a minor issue of not cleaning `./docs/*.7.gz`
Hi @murlakatamenka. This needs to be rebased onto |
Make check earlier used to ensure that scdoc could compile the docs too. We use it in CI. if that can be implemented here then we can go ahead with a merge. |
For `DEBIAN_FRONTEND` environment variable see `man 7 debconf`: - https://manpages.debian.org/bookworm/debconf-doc/debconf.7.en.html#noninteractive
8ad062d
to
4c8ed9e
Compare
Previously the docs were built into gzipped man pages during wayshot/.github/workflows/build.yml Line 19 in 8f22e6d
And also checked in a separate job: wayshot/.github/workflows/build.yml Lines 32 to 43 in 8f22e6d
Now that Ideally there should be a job or workflow that gets triggered only if those So far I'm done with the changes, feel free to review. |
Things look great. Thanks for the PR! |
I just realized something I forgot to ask. The code you've written is POSIX compliant right? I would rather keep away from bash extensions. |
Fixes #101
wayshot
faster, thus better for devs and contributors.make
more explicit about what it doesdocs/*.7.gz
not being cleaned