summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlejandro Colomar <alx@kernel.org>2024-03-19 18:29:58 +0100
committerAlejandro Colomar <alx@kernel.org>2024-03-19 18:29:58 +0100
commit580610dc4627476db12ecedffb86c8e56775c7f6 (patch)
tree85840307d1e7dc6e299df73be9aa53dec9e3ce53
parent871924189303c209285a8908b8354387aebedeb0 (diff)
GNUmakefile, INSTALL, RELEASE: Expand 'make help' to document dependencies
Signed-off-by: Alejandro Colomar <alx@kernel.org>
-rw-r--r--GNUmakefile8
-rw-r--r--INSTALL25
-rw-r--r--RELEASE19
3 files changed, 18 insertions, 34 deletions
diff --git a/GNUmakefile b/GNUmakefile
index 4cc4e88f0..7baa19bbc 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -48,9 +48,17 @@ help:
$(info )
$(info $(INFO_)To see a list of available variables, run:)
$(info $(INFO_) $$ find GNUmakefile share/mk/configure -type f \)
+ $(info $(INFO_) | sort \)
$(info $(INFO_) | xargs grep '^[^[:space:]].*=' \)
$(info $(INFO_) | sed 's/=.*/=/';)
$(info )
+ $(info )
+ $(info $(INFO_)To see a list of dependencies, run:)
+ $(info $(INFO_) $$ find share/mk/configure/build-depends -type f \)
+ $(info $(INFO_) | sed 's,share/mk/configure/build-depends/,,' \)
+ $(info $(INFO_) | sed 's,\.mk,,' \)
+ $(info $(INFO_) | sort;)
+ $(info )
.DELETE_ON_ERROR:
diff --git a/INSTALL b/INSTALL
index aac8f1013..0fdc36f71 100644
--- a/INSTALL
+++ b/INSTALL
@@ -46,7 +46,7 @@ Description
are specially designed for this project. To see all of the
available variables, use:
- $ make help-variables
+ $ make help
The most common ones that you may use are:
@@ -66,22 +66,13 @@ Description
$ make help
Dependencies
- - Build-depends:
-
- To learn the build dependencies of the project, run
-
- $ find share/mk/ -type f \
- | xargs grep include.*configure/build-depends/ \
- | sed 's,share/mk/,,' \
- | sed 's,/.*:,:,' \
- | sed 's,include $.*/, ,' \
- | sed 's,\.mk,,g' \
- | sort \
- | uniq;
-
- - Depends:
- - man(1)
- - groff(1) | mandoc(1)
+ To see the build-dependencies of the project, that is, the
+ dependencies of the build system, see `make help`.
+
+ To read the manual pages, you'll need:
+
+ - man(1)
+ - groff(1) | mandoc(1)
Lint & check
You can lint and check both the manual pages, and the example C
diff --git a/RELEASE b/RELEASE
index 97c4479c1..90a461284 100644
--- a/RELEASE
+++ b/RELEASE
@@ -12,23 +12,8 @@ Description
release, you only need step (4) "Tarball".
Dependencies
- The following list of dependencies states what the build system
- (the makefiles) need to perform the relevant (dist) targets:
-
- - echo(1)
- - expr(1)
- - find(1)
- - git(1)
- - grep(1)
- - gzip(1)
- - install(1)
- - locale(1)
- - make(1) - GNU Make is required.
- - sed(1)
- - sort(1)
- - tar(1) - GNU tar is required.
- - xargs(1)
- - xz(1)
+ To see the build-dependencies of the project, that is, the
+ dependencies of the build system, see `make help`.
Apart from that, the following commands are also needed for other
tasks shown below: