From fedfbb901157fd20bbd9ef01d4a67f1603833239 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Matthias=20Kr=C3=BCger?= <matthias.krueger@famsik.de>
Date: Sat, 13 Feb 2021 00:50:13 +0100
Subject: [PATCH] lintcheck: explain sources.toml configuration

---
 clippy_dev/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/clippy_dev/README.md b/clippy_dev/README.md
index a09365fadc4e..c02257afe12e 100644
--- a/clippy_dev/README.md
+++ b/clippy_dev/README.md
@@ -26,3 +26,26 @@ where `custom.toml` must be a relative path from the repo root.
 
 The results will then be saved to `lintcheck-logs/custom_logs.toml`.
 
+### configuring the crate sources
+The sources to check are saved in a `toml` file.  
+There are three types of sources.  
+A crates-io source:
+````toml
+bitflags = {name = "bitflags", versions = ['1.2.1']}
+````
+Requires a "name" and one or multiple "versions" to be checked.
+
+A git source:
+````toml
+puffin = {name = "puffin", git_url = "https://github.com/EmbarkStudios/puffin", git_hash = "02dd4a3"}
+````
+Requires a name, the url to the repo and unique identifier of a commit,
+branch or tag which is checked out before linting.  
+There is no way to always check `HEAD` because that would lead to changing lint-results as the repo would get updated.  
+If `git_url` or `git_hash` is missing, an error will be thrown.
+
+A local dependency:
+````toml
+ clippy = {name = "clippy", path = "/home/user/clippy"}
+````
+For when you want to add a repository that is not published yet.