CONTRIBUTING.d/lint: Rewrite now that we have $SKIP_XFAIL

Signed-off-by: Alejandro Colomar <alx@kernel.org>

1 files changed, 27 insertions, 27 deletions

diff --git a/CONTRIBUTING.d/lint b/CONTRIBUTING.d/lint
index 35a92dce70..0a936d991b 100644
--- a/CONTRIBUTING.d/lint
+++ b/CONTRIBUTING.d/lint
@@ -1,40 +1,40 @@
 Name
-       Lint - instructions for linting manual pages
+        Lint - instructions for linting manual pages
 
 Description
-       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:
+    The entire project
+        To run the linters and checks for the entire project, run
 
-       (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 lint build check;
 
-                $ make -t lint check >/dev/null
+        This skips tests that are known to fail.  To run those too, run
 
-       (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.
+            $ make lint build check SKIP_XFAIL=no;
 
-                $ # replace 'man2/membarrier.2' by the page you'll modify
-                $ make -W man2/membarrier.2 -k lint check
+    A single page
+        To run those for a single page, you can take advantage of some
+        make(1) features:
 
-       (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.
+        (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.
 
-                $ vi man2/membarrier.2  # do your work
-                $ make -k lint check
+                 $ make -t lint build 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.
+        (2)  Run make(1) again, asking it to imagine that the page
+             you're interested in has been touched.
+
+                 $ # replace 'man2/membarrier.2' by any page.
+                 $ make -W man2/membarrier.2 -k lint build check;
+
+    Dependencies
+        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.
 
 See also
-       CONTRIBUTING
-       CONTRIBUTING.d/*
-       INSTALL
+        CONTRIBUTING
+        CONTRIBUTING.d/*
+        INSTALL
 
-       $ make help
+        $ make help