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 /CONTRIBUTING | |
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 'CONTRIBUTING')
-rw-r--r-- | CONTRIBUTING | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index 30e0bc244..8b03d7563 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -2,7 +2,7 @@ Name Contributing - instructions for contributing to the project Synopsis - Mailing list, patches, lint, style guide, bug reports, and notes + Mailing list, patches, lint & check, style guide, bug reports, and notes Description Mailing list @@ -129,23 +129,23 @@ Description - Make patches against the latest version of the manual page. Use git(1) for getting the latest version. - Lint - If you plan to patch a manual page, consider running the linters - configured in the build system, to make sure your change doesn't add - new warnings. However, you might still get warnings that are not your - fault. To minimize that, do the following steps: + Lint & check + If you plan to patch a manual page, consider running the linters and + checks configured in the build system, to make sure your change doesn't + add new warnings. However, you might still get warnings that are not + your fault. To minimize that, do the following steps: (1) First use make(1)'s -t option, so that make(1) knows that it only - needs to lint again pages that you will touch. + needs to lint & check again pages that you will touch. - $ make -t lint >/dev/null + $ make -t lint check >/dev/null (2) Run make(1) again, asking it to imagine that the page wou'll modify has been touched, to see which warnings you'll still see from that page that are not your fault. $ # replace 'man2/membarrier.2' by the page you'll modify - $ make -W man2/membarrier.2 -k lint + $ make -W man2/membarrier.2 -k lint check (3) Apply your changes, and then run make(1) again. You can ignore warnings that you saw in step (2), but if you see any new ones, @@ -153,11 +153,11 @@ Description patch email. $ vi man2/membarrier.2 # do your work - $ make -k lint + $ make -k lint check See <INSTALL> for a list of dependencies that this feature requires. If you can't meet them all, don't worry; it will still run the linters - that you have available. + and checks that you have available. Style guide For a description of the preferred layout of manual pages, as well as |