1 ConE rootflatten action

     2 =======================

     3 

     4 The *rootflatten* action is intended to be a temporary solution for enabling 

     5 Configuration roots anywhere inside the project structure. The current 

     6 Configuration project specification (0.4) is defined to allow configuration roots

     7 only in the project root folder, so the root flatten will convert a file located

     8 in any subfolder of the project to root file under the project folder that follows 

     9 the Configuration project specification. 

    10 

    11 The configuration roots in the subfolders can use absolute includes to include other 

    12 configuration roots and / or layers.

    13 

    14 

    15 Examples

    16 --------

    17 

    18 **Create a flat configuration from a Country configuration**

    19 

    20 The configuration root could for example exist in family/product/country/`product_Euro2_ALPS_02_customisation_root.confml <../_static/country/product_Euro1_ALPS_01_customisation_root.confml>`_.

    21 So this configuration root includes another configuration and two extra layers. The script trusts that the normal SD naming convention is in use, where all layer root confml files 

    22 are just name root.confml (to know what is a configuration root and what is a layer). 

    23 

    24 Commands::

    25 

    26     > cd configproject_root

    27     > cone rootflatten -c family\product\country\product_Euro2_ALPS_02_customisation_root.confml

    28     Running action rootflatten

    29     Processing configurations ['family\\product\\country\\product_Euro1_ALPS_01_customisation_root.confml']

    30     opened family\product\country\product_Euro1_ALPS_01_customisation_root.confml for flattening

    31     Creating a new configuration root 'product_Euro1_ALPS_01_customisation_root.confml' for flattening

    32 

    33 After the conversion there will be a file with the same name in root where includes are flattened and meta data is merged. 

    34  * See `product_Euro2_ALPS_02_customisation_root.confml <../_static/product_Euro1_ALPS_01_customisation_root.confml>`_

    35 

    36 

    37 Options list

    38 ------------

    39 Options:

    40   -h, --help            show this help message and exit

    41   -c CONFIG, --configuration=CONFIG

    42                         Defines the name of the configuration for the action,

    43                         can be specified multiple times to include multiple

    44                         configurations.

    45   --config-wildcard=WILDCARD

    46                         Wildcard pattern for including configurations, e.g.

    47                         product_langpack_*_root.confml

    48   --config-regex=REGEX  Regular expression for including configurations, e.g.

    49                         product_langpack_\d{2}_root.confml

    50   -p STORAGE, --project=STORAGE

    51                         defines the location of current project. Default is

    52                         the current working directory.