Bug 227255 - ports-mgmt/portlint: Suggest check for pkg-descr
Summary: ports-mgmt/portlint: Suggest check for pkg-descr
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Joe Marcus Clarke
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-04-03 13:39 UTC by Jason W. Bacon
Modified: 2018-05-11 21:36 UTC (History)
1 user (show)

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


Attachments
Patch making portlint complain if pkg-descr is too short (2.21 KB, patch)
2018-04-03 23:03 UTC, Mateusz Piotrowski
0mp: maintainer-approval?
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Jason W. Bacon freebsd_committer freebsd_triage 2018-04-03 13:39:13 UTC
Suggesting a check to remind maintainers to write up a good pkg-descr.

A simple check for more than one sentence or more than one line might be sufficient to remind the maintainer to put a little more effort into it.  Main aim would be to flag on-liners that may do an inadequate job describing the port according to the handbook standard:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/porting-desc.html
Comment 1 Mateusz Piotrowski freebsd_committer freebsd_triage 2018-04-03 20:07:22 UTC
ID
Comment 2 Mateusz Piotrowski freebsd_committer freebsd_triage 2018-04-03 20:09:10 UTC
I'm sorry for the previous message.

I wanted to say that maybe we should aim for a minimum of 3 lines as it's usually at least one sentence, one blank line and one line for a WWW address.
Comment 3 Jason W. Bacon freebsd_committer freebsd_triage 2018-04-03 21:22:02 UTC
I was thinking the same, but would assume the URL line would be preprocessed out before checking the content, e.g.

lines=`wc -l pkg-descr`
head -n $((lines - 1)) | qc-command
Comment 4 Mateusz Piotrowski freebsd_committer freebsd_triage 2018-04-03 23:03:53 UTC
Created attachment 192190 [details]
Patch making portlint complain if pkg-descr is too short

I'm submitting a patch (or at least a PoC) which makes portlint complain if pkg-descr is less than 3 lines.

While here, I improved pkg-descr of portlint itself.
Comment 5 Joe Marcus Clarke freebsd_committer freebsd_triage 2018-05-11 20:19:49 UTC
Committed to my repo pending the next release.
Comment 6 Joe Marcus Clarke freebsd_committer freebsd_triage 2018-05-11 21:36:26 UTC
Committed, thanks!