1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/persistentdata/featuremgmt/featureregistry/tools/featregconfig/help.txt	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,21 @@
     1.4 +
     1.5 +This file outlines the purpose and usage of the 
     1.6 +makefeatregconfig.pl and checkfeatregconfig.pl scripts.
     1.7 +-------------------------------------------------------
     1.8 +
     1.9 +Purpose
    1.10 +-------
    1.11 +These scripts are used to generate and validate a binary configuration data file 
    1.12 +which drives the featreg api.
    1.13 +
    1.14 +Usage
    1.15 +-----
    1.16 +makefeatregconfig.pl
    1.17 +- Creates a binary configuration file called featreg.cfg in the current directory.
    1.18 +
    1.19 +checkfeatregconfig.pl <configuration file>
    1.20 +- Validates the specified configuration file and prints the contents to stdout.  If the file is invalid, reasons are printed to stdout.
    1.21 +
    1.22 +- The testconfigfiles directory contains two example configuration files which can be used to test checkfeatregconfig.pl.
    1.23 +  validfeatreg.cfg is a valid binary configuration file containing 3 feature entries and 2 default ranges.
    1.24 +  invalidfeatreg.cfg is an invalid binary configuration file as it is larger than the limit of 65535 bytes.