configurationengine/doc/cli/report.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 report action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
==================
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
The report action can be used to create a report based on report generation
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
data created beforehand by the generate action using the switch ``--report-data-output``.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
The report can be generated based on a single data file, or by merging multiple files.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
Examples
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
--------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
**Creating a report from a single data file**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
    cone report --input-data report.dat
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
This would generate a report based on the data in ``report.dat`` into ``report.html``
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
in the current directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
**Creating a report from multiple files**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
    cone report --input-data rofs3.dat --input-data uda.dat --template template.html
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
This would generate a report based the data from two generation runs, one for ROFS3 data
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
and one for UDA data. The used template is overridden using ``--template``.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
Options list
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
  --version             show program's version number and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
  -h, --help            show this help message and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
  --print-settings      Print all the default settings from the current
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
                        setting container.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
  --print-supported-impls
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
                        Print all supported ImplML XML namespaces and file
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
                        extension.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
  -v LEVEL, --verbose=LEVEL
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
                        Print error, warning and information on system out.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
                        Possible choices: Default is 3.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
                        NONE (all)    0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
                        CRITICAL      1
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
                        ERROR         2
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
                        WARNING       3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
                        INFO          4
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
                        DEBUG         5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
  --log-file=FILE       Location of the used log file. Default is 'cone.log'
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
  -p STORAGE, --project=STORAGE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
                        defines the location of current project. Default is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
                        the current working directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
  Report options:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
    The report function generates a report using previously generated
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
    intermediary report data as input.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
    -i FILE, --input-data=FILE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
                        Defines an input file for report generation. If
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
                        specified more than once, the data of all specified
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
                        report data files is merged.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
    -r FILE, --report=FILE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
                        Generates a report about settings that are properly
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    58
                        generated.Example -r report.html.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
    -t FILE, --template=FILE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
                        Template used in report generation.Example -t
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
                        report_template.html.