Missing command line option documentation #936
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The clamd and clamav-milter `--help` message and manpages do not mention the `--pid` (`-p`) option. The clamd `--help` message and manpage do not mention the `--datadir` option. Also corrected minor punctuation issues, and removed the meaningless jargon about the "main thread" which has nothing to do with the PID.
shutton
suggested changes
May 31, 2023
| @@ -83,7 +83,7 @@ Log additional information about the infected file, such as its size and hash, t | |||
| Default: no | |||
| .TP | |||
| \fBPidFile STRING\fR | |||
There was a problem hiding this comment.
STRING -> FILE (referenced in next line)
Or: "Write daemon's pid to filename contained in STRING"
There was a problem hiding this comment.
Hm same issue exists in clamav-milter.conf.5.in. Will fix both.
It's a pretty deep rabbithole to make it use FILE for both, or STRING for both. So many other options just say STRING and then something like "the specified file."
So I think I'll change it to "the specified file." to match those. Good catch!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The clamd and clamav-milter
--helpmessage and manpages do not mention the--pid(-p) option.The clamd
--helpmessage and manpage do not mention the--datadiroption.Also corrected minor punctuation issues, and removed the meaningless jargon about the "main thread" which has nothing to do with the PID.