Skip to content

Commit

Permalink
docs: mention the gitgrep backend in the Performance section
Browse files Browse the repository at this point in the history
I have been using this backend for a few days now, and have had no
issues. It seems to be working well enough to mention now!
  • Loading branch information
mikavilpas committed Feb 27, 2025
1 parent 10913a3 commit 5f992b3
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,9 @@ Generally performance is very good, but depending on the size of your project
and your computer's specifications, the search can be fast or slow. Here are a
few things you can do to improve performance:

- Use the experimental git grep backend by setting the
`future_features.backend = "gitgrep"` option (see above). This can be faster
in medium/large projects.
- Set the `prefix_min_len` option to a larger number avoid starting a search for
very short words. This can prevent unnecessary searches and improve
performance.
Expand Down

0 comments on commit 5f992b3

Please sign in to comment.