Skip to content

Commit

Permalink
README.md: link to external formatting of user manual
Browse files Browse the repository at this point in the history
Some people don't like htmlpreview.github.io.  I once or twice saw a
case where it appeared to be affected by load limits.  Since external
sites are making the manual available, and it's unlikely there are too
many changes between the last release and the current manual, just link
to it as an alternative for folks.

Signed-off-by: Elijah Newren <[email protected]>
  • Loading branch information
newren committed Apr 1, 2021
1 parent d2fdc89 commit 3f18153
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Documentation/git-filter-repo.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
// This file is NOT the documentation; it's the *source code* for it.
// Please follow the "user manual" link under
// https://github.com/newren/git-filter-repo#how-do-i-use-it
// to access the actual documentation.
// to access the actual documentation, or view another site that
// has compiled versions available, such as:
// https://www.mankier.com/1/git-filter-repo

git-filter-repo(1)
==================
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ section](https://htmlpreview.github.io/?https://github.com/newren/git-filter-rep
commands](Documentation/converting-from-bfg-repo-cleaner.md#cheat-sheet-conversion-of-examples-from-bfg),
which covers every example from the BFG website

External sites also have [alternative formats of the user
manual](https://www.mankier.com/1/git-filter-repo) available, at least
for the most recent release. This also may be beneficial if
htmlpreview.github.io starts hitting load limits.

# Why filter-repo instead of other alternatives?

This was covered in more detail in a [Git Rev News article on
Expand Down

0 comments on commit 3f18153

Please sign in to comment.