Changes between Initial Version and Version 1 of Obsolete/Development/Build/QBTAdvanced


Ignore:
Timestamp:
Mar 21, 2010, 10:59:12 AM (14 years ago)
Author:
loomis
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Obsolete/Development/Build/QBTAdvanced

    v1 v1  
     1[[TracNav]]
     2
     3At check-in time, or when the <tt>tagstable target</tt> is invoked, the build tools check a number of properties of the module.
     4
     5=Obsolete marker=
     6The 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 <tt>CHKOBS_OK</tt> to 1. For example:
     7
     8 $ make CHKOBS_OK=1 rpm
     9
     10=Mandatory files=
     11Are the '''mandatory files''' present? Currently, these are:
     12
     13<tt>LICENSE</tt>
     14<tt>ChangeLog</tt>
     15<tt>README</tt>
     16<tt>config.mk</tt>
     17
     18=Deprecated files=
     19Are any '''deprecated files''' present? Currently, these are:
     20
     21<tt>MAINTAINER</tt>
     22
     23=Mandatory comments=
     24Are the '''mandatory comments''' present in source files? Currently, these are:
     25
     26<tt>AUTHOR, MAINTAINER, VERSION</tt>.
     27
     28If you are developing your own module, define the variable <tt>_SRC_FILES</tt> in the module's <tt>Makefile</tt> as a list of source files to be checked (this is '''not needed''' for NCM components), then run
     29
     30  $ make header
     31
     32and take a look at the results.
     33
     34=Mandatory meta-tags=
     35Are '''mandatory meta tags''' present in <tt>config.mk</tt>? Currently, these are:
     36
     37<tt>AUTHOR, COMP, DESCR, MAINTAINER, NAME, VERSION</tt>
     38
     39=Deprecated pan code=
     40Is there any '''deprecated code''' in the Pan template files distributed with the module? This is mostly needed for NCM components.
     41
     42If you are developing a generic module, define the variable <tt>_DIRTY_TPL_FILES</tt> in the module's <tt>Makefile</tt> as a list of template files to be checked. Depending on the version of the Pan compiler - <tt>panc</tt> - you are using, there might be some adjustments to be done manually; check the [https://sourceforge.net/project/showfiles.php?group_id=221766&package_id=286489 pan documentation] for the current status.