configurationengine/doc/cli/generate.rst
author terytkon
Thu, 11 Mar 2010 17:04:37 +0200
changeset 0 2e8eeb919028
permissions -rw-r--r--
Adding EPL version of configurationengine.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
ConE generate action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
====================
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
Running action generate
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
Usage: cone generate [options]
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
The generate action is intended to generate output files with different implementation plugins. The
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
implementation files can be filtered by different mechanism, via the command line options. 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
Examples
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
--------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
**Generate all files of a configurations**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
    >cone generate -c configuration_root.confml
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
or use the option -p|--project to point to the configuration project root::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
    >cone generate --project=configproject_root -c configuration_root.confml
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
**Generate by filtering with values in last layer**
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
The data can be located in different layers in configuration project. Quite a common use case is to 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
generate only output files that have been changed in the last layer.::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
    >cone generate -c configuration_root.confml --layer=-1
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
This will read data value definitions on the last configuration layer (last included confml 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
file in the root file), and run generate only to implementation files that use one of these
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
data values.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
Options list
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
  --version             show program's version number and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
  -h, --help            show this help message and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
  --print-settings      Print all the default settings from the current
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
                        setting container.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
  --print-supported-impls
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
                        Print all supported ImplML XML namespaces and file
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
                        extensions.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
  -v LEVEL, --verbose=LEVEL
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
                        Print error, warning and information on system out.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
                        Possible choices: Default is 3.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
                        NONE (all)    0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
                        CRITICAL      1
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
                        ERROR         2
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
                        WARNING       3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
                        INFO          4
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
                        DEBUG         5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
  --log-file=FILE       Location of the used log file. Default is 'cone.log'
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
  -c CONFIG, --configuration=CONFIG
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
                        defines the name of the configuration for the action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
  -p STORAGE, --project=STORAGE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
                        defines the location of current project. Default is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
                        the current working directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    58
  Generate options:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
    The generate function will create target files from a specific
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
    configuration.The generate will always work with read-only mode of the
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
    project, so no changes are saved to project
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    63
    -o FOLDER, --output=FOLDER
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
                        defines the target folder where the files are is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    65
                        generated or copied
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
    -l LAYER, --layer=LAYER
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
                        define layers of the configuration that are included
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
                        to the output. The layer operation can be used several
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
                        times in a single command.Example -l -1 --layer=-2,
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    70
                        which would append a layers -1 and -2 to the layers =>
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    71
                        layers = -1,-2
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    72
    --all-layers        Include all layers in generation. This switch
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    73
                        overrides all other layer configurations (iMaker API
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    74
                        and using the --layer parameter)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    75
    -i IMPLS, --impl=IMPLS
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    76
                        Define a Python regular expression filter for actual
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    77
                        ImplML plugin(s) that needs to be executed. The whole
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    78
                        path to ImplML filename is used in the regexp
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    79
                        matching. The impl operation can be used several times
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    80
                        in a single command.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    81
                        Example1 --impl crml => matches for any ImplML file
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    82
                        that has a CrML string in the path. Example2 --impl
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    83
                        makeml$ => matches for ImplML file that has ends with
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    84
                        MakeML string.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    85
    --impl-tag=TAG      define a tag for the implementations that are included
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    86
                        to the output. A tag is name value pair and has the
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    87
                        following format: name:value, e.g.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    88
                        target:rofs3.Example --impl-tag=target:uda --impl-
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    89
                        tag=target:content, which would include impls include
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    90
                        both tags.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    91
    --impl-tag-policy=TAGS_POLICY
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    92
                        Policy for implementation tags. May have one of the
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    93
                        following values: --impl-tag-policy=AND, --impl-tag-
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    94
                        policy=OR. Default is OR.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    95
    -s SET, --set=SET   Override a ConfML reference in the execution.The set
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    96
                        operation can be used several times in a single
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    97
                        command.Example -s foo.bar=10 -s foo.fea='test'.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    98
    --add=CONF          Add a given configuration to the given configuration
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    99
                        as last element.The add operation can be used several
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   100
                        times in a single command.Example --add
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   101
                        foo/root.confml --add bar/root-confml.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   102
    -r FILE, --report=FILE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   103
                        Generates a report about settings that are properly
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   104
                        generated.Example -r report.html.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   105
    -t FILE, --template=FILE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   106
                        Template used in report generation.Example -t
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   107
                        report_template.html.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   108
    --report-data-output=FILE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   109
                        Specifies a file where intermediary report data is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   110
                        generated.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   111
    -n, --dryrun        Executes generation without generation output.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   112
    --add-setting-file=FILE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   113
                        Generate specific settings in ini format.Example -o
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   114
                        my_generate_settings.cfg.