diff options
| author | Alejandro Colomar <alx.manpages@gmail.com> | 2022-07-10 22:27:50 +0200 |
|---|---|---|
| committer | Alejandro Colomar <alx.manpages@gmail.com> | 2022-07-10 23:01:56 +0200 |
| commit | 77160b72c90184123097f621880ae3842f890357 (patch) | |
| tree | b204ffa844ebe0ba864f7712c4192533e2f5c5a6 /Makefile | |
| parent | 30f8f9456e4428cfeba9223a098741fd1dcadc59 (diff) | |
Makefile, README, INSTALL: Improve INSTALL documentation
Add a 'make help' target to document the features of our Makefile.
Move all documentation about installing from the README to a new
INSTALL file, following GNU coding standards. See
<https://www.gnu.org/prep/standards/html_node/Releases.html#Releases>.
INSTALL contains minimal information, and defers to 'make help'
for the rest.
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 66 |
1 files changed, 65 insertions, 1 deletions
@@ -56,7 +56,71 @@ MANDIRS := $(sort $(shell find $(MANDIR)/man? -type d)) .PHONY: all all: build - + @: + +.PHONY: help +help: + $(info all Alias for "build") + $(info ) + $(info clean Remove $$(builddir)) + $(info ) + $(info build Alias for "build-html") + $(info ) + $(info build-html Build HTML manual pages) + $(info html Alias for "build-html") + $(info ) + $(info build-src Alias for "build-src-ld") + $(info build-src-c Extract C programs from EXAMPLES) + $(info build-src-cc Compile C programs from EXAMPLES) + $(info build-src-ld Link C programs from EXAMPLES) + $(info ) + $(info lint Wrapper for "lint-c lint-man") + $(info lint-c Wrapper for lint-c-* targets) + $(info lint-c-checkpatch Lint C programs from EXAMPLES with checkpatch(1)) + $(info lint-c-clang-tidy Lint C programs from EXAMPLES with clang-tidy(1)) + $(info lint-c-cpplint Lint C programs from EXAMPLES with cpplint(1)) + $(info lint-c-iwyu Lint C programs from EXAMPLES with iwyu(1)) + $(info lint-man Wrapper for lint-man-* targets) + $(info lint-man-groff Lint man pages with groff(1)) + $(info lint-man-mandoc Lint man pages with mandoc(1)) + $(info ) + $(info [un]install Alias for "[un]install-man") + $(info [un]install-man Wrapper for [un]install-man* targets) + $(info [un]install-man0 [Un]install man pages in section 0) + $(info [un]install-man1 [Un]install man pages in section 1) + $(info [un]install-man2 [Un]install man pages in section 2) + $(info [un]install-man3 [Un]install man pages in section 3) + $(info [un]install-man4 [Un]install man pages in section 4) + $(info [un]install-man5 [Un]install man pages in section 5) + $(info [un]install-man6 [Un]install man pages in section 6) + $(info [un]install-man7 [Un]install man pages in section 7) + $(info [un]install-man8 [Un]install man pages in section 8) + $(info ) + $(info [un]install-html [Un]install HTML manual pages) + $(info ) + $(info dist Wrapper for dist-* targets) + $(info dist-tar Create a tarball of the repository) + $(info dist-gz Create a compressed tarball (.tar.gz)) + $(info dist-xz Create a compressed tarball (.tar.xz)) + $(info ) + $(info builddirs-dist Create directories needed by "dist") + $(info builddirs-html Create directories needed by "build-html") + $(info builddirs-src Create directories needed by "build-src") + $(info lintdirs Create directories needed by "lint") + $(info installdirs Create directories needed by "install") + $(info installdirs-html Create directories needed by "install-html") + $(info installdirs-man Create directories needed by "install-man") + $(info installdirs-man0 Create directories needed by "install-man0") + $(info installdirs-man1 Create directories needed by "install-man1") + $(info installdirs-man2 Create directories needed by "install-man2") + $(info installdirs-man3 Create directories needed by "install-man3") + $(info installdirs-man4 Create directories needed by "install-man4") + $(info installdirs-man5 Create directories needed by "install-man5") + $(info installdirs-man6 Create directories needed by "install-man6") + $(info installdirs-man7 Create directories needed by "install-man7") + $(info installdirs-man8 Create directories needed by "install-man8") + $(info ) + $(info help Print this help) .SECONDEXPANSION: |