diff options
| author | Alejandro Colomar <alx@kernel.org> | 2023-04-02 02:54:16 +0200 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2023-04-02 03:06:50 +0200 |
| commit | aa344d4ba28c988c4d7f177373d565be193e2d39 (patch) | |
| tree | 320f5701b2f85601551e82cf446dc66982d4277e /INSTALL | |
| parent | 2e1c1a57f138eedd35b7b2a825002fddb12d240f (diff) | |
*.mk, CONTRIBUTING, INSTALL: lint, build, check: Reorganize some targets
Some targets which were under lint-* were really building cat pages, so
let's call it build-catman, since it's what it is. As part of the
build, it will report warnings, of course, as any other build system, so
nothing really changed, except for the target names, and the path in the
build tree where the cat pages (and intermediate files) are placed,
which is now directly under <.tmp/man/*>.
Some other targets were checking that the cat pages were correct after
the build, so those targets have been moved to check-* targets.
Document that contributors should run both the 'lint' and 'check'
targets to check the correctness of their patches.
`make all`, a.k.a. `make build`, now builds _all_ that can be built,
including cat pages, and C programs.
Implementation detail: $LINTMAN has been renamed, since now it's used
also for things that are not linters. Call it $NONSO_MAN, since it's a
list of the non-'.so' man pages, which are the ones we want to lint,
build, and check.
Future directions:
I plan to implement 'build-html' using groff(1), which will reuse part
of the build-catman pipeline. That will produce much higher quality
HTML manual pages.
Cc: G. Branden Robinson <g.branden.robinson@gmail.com>
Cc: Elliott Hughes <enh@google.com>
Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -92,7 +92,7 @@ Description - rm(1) - rmdir(1) - - For linting man(7) source: + - For linting/building/checking man(7) source: - eqn(1) - grotty(1) - head(1) @@ -101,7 +101,7 @@ Description - tbl(1) - troff(1) >= 1.23.0 - GNU troff is required. - - For linting C source: + - For linting/building C source: - cc(1) - GCC or Clang - clang-tidy(1) - cpplint(1) @@ -124,10 +124,10 @@ Description - man(1) - groff(1) | mandoc(1) - Lint (experimental) - You can lint both the manual pages, and the example C programs - contained in them. See 'make help' for a list of targets that can be - used. + Lint & check + You can lint and check both the manual pages, and the example C + programs contained in them. See 'make help' for a list of targets that + can be used. Files Makefile, lib/install-man.mk, lib/install.mk |