Skip to content

Update manual pages to add details to --probes to contrast with --retries#740

Merged
zakird merged 7 commits intomainfrom
phillip/man-pages-probes-retries
Nov 16, 2023
Merged

Update manual pages to add details to --probes to contrast with --retries#740
zakird merged 7 commits intomainfrom
phillip/man-pages-probes-retries

Conversation

@phillip-stephens
Copy link
Contributor

  • added details to --probes to contrast with --retries
  • re-generated manual pages with make manpages
  • added .DS_Store to .gitignore. Looks like it can be auto-generated on MacOS, don't want that slipping into the repo

only relevant for MacOS, but don't want this slipping into the repo
Wanted to contrast with --retries
…ntation

Don't think `make manpages` has been run since Sept. 2017 so thought we could update it for v.4.0.0
@zakird
Copy link
Member

zakird commented Nov 14, 2023

This broadly looks good to me. We should update here to say that probes isn't number of packets per IP but per target IP/port pair. (This is my fault, but we should update it).

Can you make sure that we're also updating the --help text as well? Unfortunately the two are maintained separately. I think the text there is generally much shorter, but I did notice that under probes definition there it says packets per IP, which should be packets per ip/port too.

The last thing that I will note is that generally https://github.com/zmap/zmap/wiki has our most verbose documentation, so let's make sure that too stays in-sync with these changes.

@phillip-stephens phillip-stephens marked this pull request as ready for review November 16, 2023 04:21
@phillip-stephens
Copy link
Contributor Author

@zakird I addressed your concerns and updated the wiki with the multi-port usages. If you could re-review whenever you have a chance, that'd be great!

@zakird zakird merged commit 6e7f0a2 into main Nov 16, 2023
@zakird zakird deleted the phillip/man-pages-probes-retries branch November 16, 2023 04:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants