ggreer / the_silver_searcher

A code-searching tool similar to ack, but faster.
http://geoff.greer.fm/ag/
Apache License 2.0
26.18k stars 1.43k forks source link

Link to gitignore file format documentation in wiki "advanced usage" page? #1455

Open TysonAndre opened 3 years ago

TysonAndre commented 3 years ago

https://github.com/ggreer/the_silver_searcher/wiki/Advanced-Usage#ignoring-files currently does not link to gitignore

There's a brief note already that

.ignore uses the same patterns as .gitignore and .hgignore.

This could be elaborated further. Some ideas:

  1. Include a link to https://git-scm.com/docs/gitignore so users can learn more about
  2. Include examples and descriptions such as ! negation, etc., for users unfamiliar with the .gitignore file format
robations commented 2 years ago

I was also looking for some description or spec for the ignore format. You often find subtle differences in ignore file behaviour (*, **, negation etc) so would be good to see some stronger docs and perhaps some examples. God forbid I search through every node_modules directory.

The blog post here suggests that sift and ripgrep are using the same .ignore protocol, which suggests there should be a shared spec?