wiki:Obsolete/Development/Build/QBTAdvanced

At check-in time, or when the tagstable target is invoked, the build tools check a number of properties of the module.

Obsolete marker

The presence of an 'obsolete' marker. The failure of this test tells you that the module should neither be used nor further developed. Additionally building an RPM of the module will fail. If you really need to build the module, set the variable CHKOBS_OK to 1. For example:

 $ make CHKOBS_OK=1 rpm

Mandatory files

Are the mandatory files present? Currently, these are:

  • LICENSE
  • ChangeLog
  • README
  • config.mk

Deprecated files

Are any deprecated files present? Currently, these are:

  • MAINTAINER

Mandatory comments

Are the mandatory comments present in source files? Currently, these are:

  • AUTHOR
  • MAINTAINER
  • VERSION

If you are developing your own module, define the variable _SRC_FILES in the module's Makefile as a list of source files to be checked (this is not needed for NCM components), then run

  $ make header

and take a look at the results.

Mandatory meta-tags

Are mandatory meta tags present in config.mk? Currently, these are:

  • AUTHOR
  • COMP
  • DESCR
  • MAINTAINER
  • NAME
  • VERSION

Deprecated pan code

Is there any deprecated code in the Pan template files distributed with the module? This is mostly needed for NCM components.

If you are developing a generic module, define the variable _DIRTY_TPL_FILES in the module's Makefile as a list of template files to be checked. Depending on the version of the Pan compiler - panc - you are using, there might be some adjustments to be done manually; check the pan documentation for the current status.

Last modified 14 years ago Last modified on Mar 21, 2010, 11:04:42 AM