diff options
| author | Alejandro Colomar <alx@kernel.org> | 2024-02-03 22:08:01 +0100 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2024-02-03 22:53:10 +0100 |
| commit | 89cd7d9c9ca03976a3459e45cc055b38e47bd134 (patch) | |
| tree | 1cada850b577ee696b35b0c56ffa86127f8ff1d9 /CONTRIBUTING | |
| parent | ebc51bed31c9075d2070d2029e91876803fdd712 (diff) | |
CONTRIBUTING, CONTRIBUTING.d/lint: Split CONTRIBUTING file
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'CONTRIBUTING')
| -rw-r--r-- | CONTRIBUTING | 32 |
1 files changed, 1 insertions, 31 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index 65556d7c2..e178f1e3f 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -150,37 +150,6 @@ Description - Make patches against the latest version of the manual page. Use git(1) for getting the latest version. - 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 & check again pages that you will touch. - - $ 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 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, please fix them if you know how, or at least note - them in your patch email. - - $ vi man2/membarrier.2 # do your work - $ 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 and checks that you have available. - Style guide For a description of the preferred layout of manual pages, as well as some style guide notes, see: @@ -194,6 +163,7 @@ Description See also CONTRIBUTING.d/bugs CONTRIBUTING.d/external_pages + CONTRIBUTING.d/lint man-pages(7) |