diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2015-01-26 23:45:27 +0100 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2015-01-26 23:45:27 +0100 |
| commit | 873c4085c824da90a1d3f89d7b9e4198376bfa49 (patch) | |
| tree | 946d447540673daec8e8507f06129d9f0cbe242a | |
| parent | ffc3a02b5ac0196d7e84d4ba9cdfbfcaaca21382 (diff) | |
| download | guix-873c4085c824da90a1d3f89d7b9e4198376bfa49.tar.gz guix-873c4085c824da90a1d3f89d7b9e4198376bfa49.tar.xz | |
doc: Expound a bit on 'guix lint'.
* doc/guix.texi (Invoking guix lint): Give examples of checkers.
| -rw-r--r-- | doc/guix.texi | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 7eed637c26..754aae9626 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -3212,8 +3212,25 @@ Use @var{host} as the OpenPGP key server when importing a public key. @node Invoking guix lint @section Invoking @command{guix lint} The @command{guix lint} is meant to help package developers avoid common -errors and use a consistent style. It runs a few checks on a given set of -packages in order to find common mistakes in their definitions. +errors and use a consistent style. It runs a number of checks on a +given set of packages in order to find common mistakes in their +definitions. Available @dfn{checkers} include (see +@code{--list-checkers} for a complete list): + +@table @code +@item synopsis +@itemx description +Validate certain typographical and stylistic rules about package +descriptions and synopses. + +@item inputs-should-be-native +Identify inputs that should most likely be native inputs. + +@item source +@itemx home-page +Probe @code{home-page} and @code{source} URLs and report those that are +invalid. +@end table The general syntax is: |