Bug 244485 - Mk/Scripts: warn about options without a description
Summary: Mk/Scripts: warn about options without a description
Status: New
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Ports Framework (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Port Management Team
Depends on:
Reported: 2020-02-27 22:07 UTC by Gerald Pfeifer
Modified: 2020-02-28 14:18 UTC (History)
2 users (show)

See Also:


Note You need to log in before you can comment on or make changes to this bug.
Description Gerald Pfeifer freebsd_committer 2020-02-27 22:07:34 UTC
emulators/wine-devel as of revision r527076 lacks a description for the
STAGING options.  I'll fix that shortly, but was surprised neither the
ports infrastructure nor portlint warned about this.

Put into a shell script the following code does that job:

   if make showconfig | grep -v === | grep -v : ; then
       echo "'make showconfig' has option(s) without a description."

Unfortunately Mk/Scripts is hard for me to grok, but for someone with
background hopefully relatively straightforward to adjust?
Comment 1 commit-hook freebsd_committer 2020-02-28 10:44:07 UTC
A commit references this bug:

Author: gerald
Date: Fri Feb 28 10:43:17 UTC 2020
New revision: 527327
URL: https://svnweb.freebsd.org/changeset/ports/527327

  Add a description for the STAGING option that we've been missing.

  Reported by:	salvadore
  PR:		244480, 244485

Comment 2 Mathieu Arnold freebsd_committer 2020-02-28 14:18:30 UTC
I wanted to do something about this a while back, but bsd.options.desc.mk is only parsed if you run make config or make showconfig.
(Because it is very fat and not needed most of the time.)
It happens around lines 4980 of Mk/bsd.ports.mk.

All would be needed is to add, something like this in all the loops:

.      if empty(${opt}_DESC)
DEV_WARNING+=   "The ${opt} option does not have an associated ${opt}_DESC"
.      endif