Skip to content

Improve docs on --ignore-file #88

Open
@petdance

Description

@petdance

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.


Comment from @jgbishop

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:

Make the available filter types stand out better, seeing as they don't necessarily only apply to creating new file types
Provide something better to link to in various parts of the manual (again, for places that don't necessarily refer to creating custom types); i.e. users wouldn't have to read through the entire block of text on creating user types to get to the information they want

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions