beyondgrep / ack2

**ack 2 is no longer being maintained. ack 3 is the latest version.**
https://github.com/beyondgrep/ack3/
Other
1.48k stars 140 forks source link

Improve documentation of --ignore-file #294

Closed petdance closed 7 years ago

petdance commented 11 years ago

Email from @delvarworld to the ack-users mailing list.

This page is a mess in terms of --ignore-file:

http://beyondgrep.com/documentation/

I was lucky enough to find an example ackrc through google that showed

--ignore-file=match:file.txt --ignore-file=match:/regexp/

but beyond that I have no idea what my options are for --ignore-file. I am also trying to construct a regex with forward slashes in it but it doesn't seem to be working. The documentation is very lacking in terms of how to do this.

jgbishop commented 10 years ago

I think it might be beneficial to create a new sub-heading (=head2) named Available filter types (or something similar) under the Defining your own types heading in the manual. This would:

This would at least assist with this issue, if not fix it. If that sounds reasonable, I'll take a stab at implementing this.

That said, I think the documentation page should point to the manual, not to the --help output. The latter is a reminder for what switch is what, while the former is more of what I'd call documentation. Just a thought.

petdance commented 7 years ago

These notes have been added to the --ignore-file ticket in ack 3 https://github.com/petdance/ack3/issues/7