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.
sl@0
     1
sl@0
     2
This file outlines the purpose and usage of the 
sl@0
     3
makefeatregconfig.pl and checkfeatregconfig.pl scripts.
sl@0
     4
-------------------------------------------------------
sl@0
     5
sl@0
     6
Purpose
sl@0
     7
-------
sl@0
     8
These scripts are used to generate and validate a binary configuration data file 
sl@0
     9
which drives the featreg api.
sl@0
    10
sl@0
    11
Usage
sl@0
    12
-----
sl@0
    13
makefeatregconfig.pl
sl@0
    14
- Creates a binary configuration file called featreg.cfg in the current directory.
sl@0
    15
sl@0
    16
checkfeatregconfig.pl <configuration file>
sl@0
    17
- Validates the specified configuration file and prints the contents to stdout.  If the file is invalid, reasons are printed to stdout.
sl@0
    18
sl@0
    19
- The testconfigfiles directory contains two example configuration files which can be used to test checkfeatregconfig.pl.
sl@0
    20
  validfeatreg.cfg is a valid binary configuration file containing 3 feature entries and 2 default ranges.
sl@0
    21
  invalidfeatreg.cfg is an invalid binary configuration file as it is larger than the limit of 65535 bytes.