From ccc37d3423ac64670c9c90e723d191c52357566b Mon Sep 17 00:00:00 2001
From: Elijah Newren <newren@gmail.com>
Date: Sat, 5 Jun 2021 11:54:43 -0700
Subject: [PATCH] lint-history: explain filename paths

It was not clear for some users that the filenames would be relative
paths from the toplevel of the repository.  Add some text to explain
this.

Reported-by: @ruv on GitHub
Signed-off-by: Elijah Newren <newren@gmail.com>
---
 contrib/filter-repo-demos/lint-history | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/contrib/filter-repo-demos/lint-history b/contrib/filter-repo-demos/lint-history
index a9630c6..0695a08 100755
--- a/contrib/filter-repo-demos/lint-history
+++ b/contrib/filter-repo-demos/lint-history
@@ -59,6 +59,9 @@ example_text = '''CALLBACK
         def is_relevant(filename):
             BODY
 
+    Where filename is the full relative path from the toplevel of the
+    repository.
+
     Thus, to only run on files with a ".txt" extension you would run
         lint-history --relevant 'return filename.endswith(b".txt")' ...