os/persistentdata/featuremgmt/featureregistry/tools/featregconfig/help.txt
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 
     2 This file outlines the purpose and usage of the 
     3 makefeatregconfig.pl and checkfeatregconfig.pl scripts.
     4 -------------------------------------------------------
     5 
     6 Purpose
     7 -------
     8 These scripts are used to generate and validate a binary configuration data file 
     9 which drives the featreg api.
    10 
    11 Usage
    12 -----
    13 makefeatregconfig.pl
    14 - Creates a binary configuration file called featreg.cfg in the current directory.
    15 
    16 checkfeatregconfig.pl <configuration file>
    17 - Validates the specified configuration file and prints the contents to stdout.  If the file is invalid, reasons are printed to stdout.
    18 
    19 - The testconfigfiles directory contains two example configuration files which can be used to test checkfeatregconfig.pl.
    20   validfeatreg.cfg is a valid binary configuration file containing 3 feature entries and 2 default ranges.
    21   invalidfeatreg.cfg is an invalid binary configuration file as it is larger than the limit of 65535 bytes.