configurationengine/doc/cli/compare.rst
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
equal deleted inserted replaced
2:87cfa131b535 3:e7e0ae78773e
    11 **Compare two configurations in current storage**::
    11 **Compare two configurations in current storage**::
    12 
    12 
    13     >cd configproject_root
    13     >cd configproject_root
    14     >cone compare -s configuration_root1.confml -t configuration_root2.confml
    14     >cone compare -s configuration_root1.confml -t configuration_root2.confml
    15 
    15 
    16 By default the output is generated under current folder to compare.html (use switch --report=FILENAME
    16 The output is generated under current folder.
       
    17 By default the compare type is data comparison to data_comparison.html (use switch --report=FILENAME
    17 to change the output file).
    18 to change the output file).
       
    19 
       
    20 * Example output `Data comparison report <../_static/data_comparison.html>`_
    18 
    21 
    19 **Compare configurations between the current storage and some remote storage**:
    22 **Compare configurations between the current storage and some remote storage**:
    20 
    23 
    21 The target configuration can also include remote storage path, which must be separated from the 
    24 The target configuration can also include remote storage path, which must be separated from the 
    22 configuration root by semicolon::
    25 configuration root by semicolon::
    28 
    31 
    29 Use the --report-type switch make an API comparison.::
    32 Use the --report-type switch make an API comparison.::
    30 
    33 
    31     >cd configproject_root
    34     >cd configproject_root
    32     >cone compare -s configuration_root1.confml -t \config_project2;configuration_root2.confml --report-type api
    35     >cone compare -s configuration_root1.confml -t \config_project2;configuration_root2.confml --report-type api
       
    36 
       
    37 * Example output `API comparison report <../_static/api_comparison.html>`_
       
    38 
       
    39 **Compare Customisation interface to a product configuration interface**
       
    40 
       
    41 The **ci** comparison is created for specific comparison of Customisation interface to a product configuration interface. Its purpose is to find out differences between the CI and actual developer confmls (for example in assets/s60 layer). It compares the source configuration to target and reports differences and source features that are missing from target configuration. 
       
    42 
       
    43 Use the --report-type switch make an ci (CustomisationInterface) comparison.::
       
    44 
       
    45     >cd configproject_root
       
    46     >cone compare -s customisation\CustomisationInterface\ci_root.confml -t vasco_langpack_01_root.confml --report-type=ci
       
    47     Writing report to ci_comparison.html
       
    48     Generated report to 'ci_comparison.html'
       
    49     Done.
       
    50 
       
    51 * Example output `CI comparison report <../_static/ci_comparison.html>`_
       
    52 
    33 
    53 
    34 **Compare configurations using a custom template**
    54 **Compare configurations using a custom template**
    35 
    55 
    36 Use the --template switch to specify a custom template file.::
    56 Use the --template switch to specify a custom template file.::
    37 
    57 
    85                         value is determined by the used report type. Example:
   105                         value is determined by the used report type. Example:
    86                         -t report_template.html.
   106                         -t report_template.html.
    87     --report-type=TYPE  The type of the report to generate. This is a
   107     --report-type=TYPE  The type of the report to generate. This is a
    88                         convenience switch for setting the used template.
   108                         convenience switch for setting the used template.
    89                         Possible values:
   109                         Possible values:
    90                         api  - Report changes in feature definitions
   110                         api - Report changes in feature definitions
       
   111                         ci - Report changes in CustomisationInterface definitions
       
   112                         crml_dc - Report CRML data compatibility issues
       
   113                         crml_dc_csv - Report CRML data compatibility issues
       
   114                         (CSV format)
    91                         data - Report changes in data values
   115                         data - Report changes in data values
    92                         crml_dc - Report CRML data compatibility issues
       
    93     --impl-filter=PATTERN
   116     --impl-filter=PATTERN
    94                         The pattern used for filtering implementations for the
   117                         The pattern used for filtering implementations for the
    95                         comparison. See the switch --impl in action generate
   118                         comparison. See the switch --impl in action generate
    96                         for more info.
   119                         for more info.