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


Ignore:
Timestamp:
Mar 21, 2010, 11:04:42 AM (14 years ago)
Author:
loomis
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Obsolete/Development/Build/QBTAdvanced

    v1 v2  
    11[[TracNav]]
    22
    3 At check-in time, or when the <tt>tagstable target</tt> is invoked, the build tools check a number of properties of the module.
     3At check-in time, or when the `tagstable target` is invoked, the build tools check a number of properties of the module.
    44
    5 =Obsolete marker=
    6 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 <tt>CHKOBS_OK</tt> to 1. For example:
     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 `CHKOBS_OK` to 1. For example:
     7{{{
     8 $ make CHKOBS_OK=1 rpm
     9}}}
    710
    8  $ make CHKOBS_OK=1 rpm
     11= Mandatory files =
     12Are the '''mandatory files''' present? Currently, these are:
     13 * `LICENSE`
     14 * `ChangeLog`
     15 * `README`
     16 * `config.mk`
    917
    10 =Mandatory files=
    11 Are the '''mandatory files''' present? Currently, these are:
     18= Deprecated files =
     19Are any '''deprecated files''' present? Currently, these are:
     20 * `MAINTAINER`
    1221
    13 <tt>LICENSE</tt>
    14 <tt>ChangeLog</tt>
    15 <tt>README</tt>
    16 <tt>config.mk</tt>
     22= Mandatory comments =
     23Are the '''mandatory comments''' present in source files? Currently, these are:
     24 * `AUTHOR`
     25 * `MAINTAINER`
     26 * `VERSION`
    1727
    18 =Deprecated files=
    19 Are any '''deprecated files''' present? Currently, these are:
    20 
    21 <tt>MAINTAINER</tt>
    22 
    23 =Mandatory comments=
    24 Are the '''mandatory comments''' present in source files? Currently, these are:
    25 
    26 <tt>AUTHOR, MAINTAINER, VERSION</tt>.
    27 
    28 If 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 
     28If 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
     29{{{
    3030  $ make header
    31 
     31}}}
    3232and take a look at the results.
    3333
    34 =Mandatory meta-tags=
    35 Are '''mandatory meta tags''' present in <tt>config.mk</tt>? Currently, these are:
     34= Mandatory meta-tags =
     35Are '''mandatory meta tags''' present in `config.mk`? Currently, these are:
     36 * `AUTHOR`
     37 * `COMP`
     38 * `DESCR`
     39 * `MAINTAINER`
     40 * `NAME`
     41 * `VERSION`
    3642
    37 <tt>AUTHOR, COMP, DESCR, MAINTAINER, NAME, VERSION</tt>
    38 
    39 =Deprecated pan code=
     43= Deprecated pan code =
    4044Is there any '''deprecated code''' in the Pan template files distributed with the module? This is mostly needed for NCM components.
    4145
    42 If 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.
     46If 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 [https://sourceforge.net/project/showfiles.php?group_id=221766&package_id=286489 pan documentation] for the current status.