From 4702650752f8984ef15e340f5ea3d926ab1f23e1 Mon Sep 17 00:00:00 2001
From: Ben Hutchings <ben.hutchings@codethink.co.uk>
Date: Tue, 8 Sep 2020 15:42:11 +0100
Subject: Add script to validate lorry files

Relates to #1.
---
 README | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'README')

diff --git a/README b/README
index 97edebf..e7d568e 100644
--- a/README
+++ b/README
@@ -16,3 +16,19 @@ add any additional configuration to this repository.
 Remember, the Lorry tool is not permitted to manage repositories inside your
 prefix which is baserock.
 
+Validation
+----------
+
+Run `scripts/validate-lorries` to check the `.lorry` files.  This will
+report:
+
+* Invalid YAML/JSON syntax
+* Wrong data types
+* Duplicate repository names
+* Missing required keys
+* Unexpected keys
+* Invalid values
+
+The syntax and duplicate name checks are applied even to disabled
+`.lorry` files, because reusing a repository name for a different
+upstream type generally won't work.
-- 
cgit v1.2.1