Bug 243979 - Porter's Handbook: 3.5. Checking the Port with portlint - Lacks appropriate options
Summary: Porter's Handbook: 3.5. Checking the Port with portlint - Lacks appropriate o...
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-doc mailing list
URL:
Keywords: needs-qa
Depends on:
Blocks:
 
Reported: 2020-02-08 11:17 UTC by Vincent DEFERT
Modified: 2020-02-10 05:05 UTC (History)
2 users (show)

See Also:
koobs: maintainer-feedback? (marcus)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Vincent DEFERT 2020-02-08 11:17:57 UTC
The documentation recommends to use portlint to check conformance with guidelines.

However, when reading portlint's man page, it seems "portlint <directory>" is enough, but when submitting the new port, you get an error report from which you realize you should have used portlint -C instead (and possibly also -A).

The porter's handbook should mention the options to use with portlint to perform the same level of verification as when the new port will be submitted.
Comment 1 Joe Marcus Clarke freebsd_committer 2020-02-09 21:11:08 UTC
I would add documentation that states committers should use -C prior to committing a port.  When building a new port, use -N (and maybe -C as well) to check it.