[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
02/02: doc: Expound a bit on 'guix lint'.
From: |
Ludovic Courtès |
Subject: |
02/02: doc: Expound a bit on 'guix lint'. |
Date: |
Mon, 26 Jan 2015 22:45:40 +0000 |
civodul pushed a commit to branch master
in repository guix.
commit 873c4085c824da90a1d3f89d7b9e4198376bfa49
Author: Ludovic Courtès <address@hidden>
Date: Mon Jan 26 23:45:27 2015 +0100
doc: Expound a bit on 'guix lint'.
* doc/guix.texi (Invoking guix lint): Give examples of checkers.
---
doc/guix.texi | 21 +++++++++++++++++++--
1 files changed, 19 insertions(+), 2 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index 7eed637..754aae9 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
address@hidden for a complete list):
+
address@hidden @code
address@hidden synopsis
address@hidden description
+Validate certain typographical and stylistic rules about package
+descriptions and synopses.
+
address@hidden inputs-should-be-native
+Identify inputs that should most likely be native inputs.
+
address@hidden source
address@hidden home-page
+Probe @code{home-page} and @code{source} URLs and report those that are
+invalid.
address@hidden table
The general syntax is: