configurationengine/doc/cli/common.rst
author m2lahtel
Tue, 10 Aug 2010 14:29:28 +0300
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
permissions -rw-r--r--
ConE 1.2.11 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     1
.. _cone-cli:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     2
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
Cone command line interface
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
===========================
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
ConE command line interface is desinged to offer different actions. A action can be anything that utilizes the ConE interface and 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
somehow interacts with a Configuration Project. Each action has it's own set of command line arguments.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
Calling ConE
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
All ConE commands are wrapped up by the cone.cmd, which executes internally cone_tool.py. The cone_tool.py searches for all conesub_*.py 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
matching files under the same scripts folder under cone installation. So basically adding a new action is just adding a new conesub_*.py file.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
To get a list of all available cone commands run::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
    cone -h
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
or::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
    cone --help
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
  
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
And you will get something like this as output::
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    24
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    25
    Usage: ConE [action] [options].
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    26
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    27
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    28
    Use ConE [action] -h to get action specific help.
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
    Available actions
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    31
    Main actions for one or more configurations.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    32
        compare : Compare two configurations
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    33
        fix : Run automatic fixes for configurations.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    34
        generate : Generate a configuration.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    35
        report : Create report of existing report data.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    36
        update : Update/set values to features in configuration(s).
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    37
        validate : Validate a configuration, or individual confml/imp
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
    
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    40
    Actions related to the configuration project maintenance.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    41
        export : Export configurations.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    42
        info : Get information about project / configurations.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    43
        merge : Merge a configuration/layer to the project.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    44
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    45
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    46
    extensions:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    47
        initvariant : Initialize a variant from a cpf.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    48
        packvariant : Pack (zip) the variant layers of a configuration.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    49
        rootflatten : Configuration root flattener.
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
ConE actions
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
.. toctree::
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    55
    :maxdepth: 1
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    57
    generate
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    58
    fix
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
    compare
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    60
    report
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    61
    update
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    62
    validate
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    63
    export
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
    merge
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    65
    info
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    66
    initvariant
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    67
    rootflatten
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68