-
-
Notifications
You must be signed in to change notification settings - Fork 42
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.
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
doc/manpages: New "lint" target to check generated man-pages #331
base: master
Are you sure you want to change the base?
Conversation
This new script will check every generated man-page to find anything wrong. See davmac314#330 for an example. Signed-off-by: Mobin Aydinfar <mobin@mobintestserver.ir>
@davmac314 Is it useful for man-pages? I think yes. Currently it's marked as draft because we need to adjust warnings that we want and it's missing a CI workflow.
|
# There is an annoying warning about date from mandoc: | ||
# | ||
# mandoc: ./dinit-service.5:1:23: WARNING: cannot parse date, using it verbatim: TH January 2024 | ||
# | ||
# We want to get rid of it. | ||
suppress_warning "WARNING: cannot parse date, using it verbatim:" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a good thing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You tell me! What date format is it expecting? Do other man pages (other projects) conform to what it expects?
In general I don't think it's a good idea to try to filter the output of a tool in this way, though.
ebd8e68
to
efea95e
Compare
Signed-off-by: Mobin Aydinfar <mobin@mobintestserver.ir>
CI workflow has been added. Failure is because of current warnings from mandoc. |
I'm not convinced these warnings are accurate enough generally to make this a gate requirement for CI. I see both incorrect warnings:
(It's an LP after the SH, not a PP) and warnings about sequences that groff understands but that mandoc doesn't:
I haven't evaluated the rest of the warnings. As the person who instigated this, you should do that yourself. Figure out what the warnings mean, whether they are correct, what is required to fix them and whether it is worth doing so. There is at least one thing actually worth fixing - so it would be good if you could raise a PR to fix that and any other genuine issues - but unless you can provide a better idea of how actually useful this is, I don't want it to be part of CI. |
This new script will check every generated man-page to find anything wrong.
See #330 for an example.
There will be a workflow for checking them in CI.
Signed-off-by: Mobin Aydinfar <mobin@mobintestserver.ir>