Bug 243979

Summary: Porter's Handbook: 3.5. Checking the Port with portlint - Lacks appropriate options
Product: Documentation Reporter: Vincent DEFERT <20.100>
Component: Books & ArticlesAssignee: Fernando ApesteguĂ­a <fernape>
Status: Closed Overcome By Events    
Severity: Affects Only Me CC: fernape, linimon, marcus
Priority: --- Keywords: needs-qa
Version: LatestFlags: koobs: maintainer-feedback? (marcus)
Hardware: Any   
OS: Any   

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 freebsd_triage 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.
Comment 2 Fernando ApesteguĂ­a freebsd_committer freebsd_triage 2023-08-28 07:28:10 UTC
The use of portlint, including -C and -A was documented in https://cgit.freebsd.org/doc/commit/?id=6e36b3077332facc9d6391d1c30e00db7d227641