Skip to content

Commit f8c14d1

Browse files
committed
git-filter-repo.txt: point people at the generated documentation
People keep trying to read this file, unaware that it is the source code for generating the documentation, not the generated documentation. Add a comment at the top that explains this and points people in the right direction. Signed-off-by: Elijah Newren <[email protected]>
1 parent 38e70b6 commit f8c14d1

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Documentation/git-filter-repo.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
// This file is NOT the documentation; it's the *source code* for it.
2+
// Please follow the "user manual" link under
3+
// https://github.com/newren/git-filter-repo#how-do-i-use-it
4+
// to access the actual documentation.
5+
16
git-filter-repo(1)
27
==================
38

0 commit comments

Comments
 (0)