Fixing inconsistencies in --man and --help output #159

Closed
hoelzro opened this Issue Dec 7, 2012 · 1 comment

Comments

Projects
None yet
2 participants
@hoelzro
Collaborator

hoelzro commented Dec 7, 2012

This list of things may overlap with other documentation-related issues, but to me, it's a pretty comprehensive list of what's incorrect in our current documentation, at least with regards to options:

  • --colour is not documented in --man ( DONE )
  • -g explanation in --help/--man is no longer accurate ( DONE )
  • Clarify that -H is the default unless you're searching a single explicitly specified file
  • -i, -v, -Q, --smart-case + -g needs fixing in --man
  • --man uses the wording "--match REGEX", but --help uses "--match PATTERN"
  • --type-set/--type-add in both --help and --man both explain old usage (see also Defining your own types in --man)
  • We should probably document the caveats when using -w
    • It might be nice to deliver a warning when using -w and a pattern that triggers that behavior.
  • --ignore-ack-defaults, --ackrc, and --dump are not found in the options section of --man ( DONE )
  • We sometimes refer to --line, and sometimes to --lines. Make sure we only ever refer to --line (or is it --lines?).
    • The option specification is --lines, but ack 1 documentation seems to indicate --line.
  • We have --with-filename, but not --without-filename (we use --no-filename). Should we at least add --without-filename?
  • In the --man output, two styles are used to describe boolean options: --group/--nogroup as well as --[no]group. We should pick a style and be consistent.
  • --ignore-file/--ignore-dir don't use ack2 filters in their documentation (specifically --help).

mmcclimon added a commit to mmcclimon/ack2 that referenced this issue Apr 18, 2013

Documentation changes (for issue #159).
This contains fixes for most of issue 159 (the parts I could actually
do).

- Fixed consistencies between --help and --man
- Clarified default for -H option
- Change all occurrences of REGEX in man to PATTERN
- Added option/documentation for --without-filename
- Changed to --[no]group style throughout man, except where the positive
  option requred an argument (e.g. --pager=program and --nopager, and not
  --[no]pager=program)

mmcclimon added a commit to mmcclimon/ack2 that referenced this issue Apr 18, 2013

Documentation changes (for issue #159).
This contains fixes for most of issue 159 (the parts I could actually
do).

- Fixed consistencies between --help and --man
- Clarified default for -H option
- Change all occurrences of REGEX in man to PATTERN
- Added option/documentation for --without-filename
- Changed to --[no]group style throughout man, except where the positive
  option requred an argument (e.g. --pager=program and --nopager, and not
  --[no]pager=program)

petdance added a commit that referenced this issue Apr 19, 2013

Documentation changes (for issue #159).
This contains fixes for most of issue 159 (the parts I could actually
do).

- Fixed consistencies between --help and --man
- Clarified default for -H option
- Change all occurrences of REGEX in man to PATTERN
- Changed to --[no]group style throughout man, except where the positive
  option requred an argument (e.g. --pager=program and --nopager, and not
  --[no]pager=program)

@petdance petdance removed this from the Later milestone Mar 18, 2017

@petdance

This comment has been minimized.

Show comment Hide comment
@petdance

petdance Mar 29, 2017

Collaborator

This issue was moved to petdance/ack3#38

Collaborator

petdance commented Mar 29, 2017

This issue was moved to petdance/ack3#38

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment