CONTRIBUTING.d/lint

   1 Name
   2         Lint - instructions for linting manual pages
   3
   4 Description
   5     The entire project
   6         To run the linters and checks for the entire project, run
   7
   8             $ make lint build check;
   9
  10         This skips tests that are known to fail.  To run those too, run
  11
  12             $ make lint build check SKIP_XFAIL=no;
  13
  14     A single page
  15         To run those for a single page, you can take advantage of some
  16         make(1) features:
  17
  18         (1)  First use make(1)'s -t option, so that make(1) knows that
  19              it only needs to lint & check again pages that you will
  20              touch.
  21
  22                  $ make -t lint build check;
  23
  24         (2)  Run make(1) again, asking it to imagine that the page
  25              you're interested in has been touched.
  26
  27                  $ # replace 'man2/membarrier.2' by any page.
  28                  $ make -W man2/membarrier.2 -k lint build check;
  29
  30     Dependencies
  31         See <INSTALL> for a list of dependencies that this feature
  32         requires.  If you can't meet them all, don't worry; it will still
  33         run the linters and checks that you have available.
  34
  35 See also
  36         CONTRIBUTING
  37         CONTRIBUTING.d/*
  38         INSTALL
  39
  40         $ make help