Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvements #240

Merged
merged 2 commits into from
Jan 30, 2022
Merged

Documentation improvements #240

merged 2 commits into from
Jan 30, 2022

Conversation

auerswal
Copy link
Collaborator

Two small improvements to the documentation, i.e., fping.pod and fping -h output:

  1. Adjust documentation for -d and -n to the implemented behavior.
  2. Slightly expand the documentation for -Q.

@auerswal
Improve -d and -n documentation
1452bf3 
* Adjust `fping.pod` entries for `-d, --rdns` and `-n, --name`:

  * The code performs reverse DNS lookups on the given targets,
    not on source addresses from ICMP Echo Responses or ICMP
    error messages.  Adjust the `-d` description to reflect this.

  * The sentence describing `-n` seems incomplete, so provide a
    completion in similar spirit to `-d`.

* Add `-d, --rdns` to `-h, --help` output since `-d` and `-n` are
  no longer equivalent.
@auerswal
Improve -Q documentation
36b652b 
The `-Q, --squiet=SECS` option does not replace the summary
statistics of `-q, --quiets`, but adds interval summary
statistics every SECS seconds to the output.
@schweikert
Copy link
Owner

Thanks!

@schweikert schweikert merged commit 052b58b into schweikert:develop Jan 30, 2022
@auerswal auerswal deleted the doc-fixes branch January 30, 2022 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@auerswal @schweikert