configurationengine/doc/cli/fix.rst
changeset 3 e7e0ae78773e
equal deleted inserted replaced
2:87cfa131b535 3:e7e0ae78773e
       
     1 ConE fix action
       
     2 ================
       
     3 Running action fix
       
     4 Usage: cone fix [options]
       
     5 
       
     6 The fix functionality is meant for running possible automatic fixes to problems which validation reports.
       
     7 
       
     8 Examples
       
     9 --------
       
    10 
       
    11 **Fix a configuration**::
       
    12 
       
    13     >cd configproject_root
       
    14     >cone fix -c configuration_root.confml
       
    15 
       
    16 or use the option -p|--project to point to the configuration project root::
       
    17 
       
    18     >cone fix --project=configproject_root -c configuration_root.confml
       
    19 
       
    20 **Print a list of available fix classes**::
       
    21 
       
    22     >cone fix --print-available-fixes
       
    23     
       
    24     Running action fix
       
    25     Available fixers:
       
    26     <class 'cone.validation.builtinvalidators.confml.DuplicateFeatureFixer'>:
       
    27         A Fix class for duplicate features that merges all setting under a duplicate feature
       
    28         to the first instance of the feature and removes the duplicates.
       
    29         
       
    30 Options list
       
    31 ------------
       
    32   --version             show program's version number and exit
       
    33   -h, --help            show this help message and exit
       
    34   --print-settings      Print all the default settings from the current
       
    35                         setting container.
       
    36   --print-supported-impls
       
    37                         Print all supported ImplML XML namespaces and file
       
    38                         extensions.
       
    39   --print-runtime-info  Print runtime information about ConE.
       
    40   -v LEVEL, --verbose=LEVEL
       
    41                         Print error, warning and information on system out.
       
    42                         Possible choices: Default is 3.
       
    43                         NONE (all)    0
       
    44                         CRITICAL      1
       
    45                         ERROR         2
       
    46                         WARNING       3
       
    47                         INFO          4
       
    48                         DEBUG         5
       
    49   --log-file=FILE       Location of the used log file. Default is 'cone.log'
       
    50   --log-config=FILE     Location of the used logging configuration file.
       
    51                         Default is 'logging.ini'
       
    52   --username=USERNAME   Username for webstorage operations. Not needed for
       
    53                         filestorage or cpf storage. If the username
       
    54                         is not given, the tool will use the logged in
       
    55                         username. Example: cone export -p webstorage_url -r .
       
    56                         -c sample.confml --username=admin --password=abc123.
       
    57   --password=PASSWORD   Password for webstorage operations. Not needed for
       
    58                         filestorage or cpf storage. If the password
       
    59                         is not given, the tool will prompt for password if
       
    60                         needed.
       
    61   -c CONFIG, --configuration=CONFIG
       
    62                         Defines the name of the configuration for the action
       
    63   -p STORAGE, --project=STORAGE
       
    64                         defines the location of current project. Default is
       
    65                         the current working directory.
       
    66 
       
    67   Fix options:
       
    68     The fix action is intended for performing fixes on a
       
    69     configuration.
       
    70 
       
    71     --print-available-fixes
       
    72                         Print all configuration fixer objects available.
       
    73     --exclude-filter=EXCLUDE_FILTER
       
    74                         Exclude problems by given filter. Examples: --exclude-
       
    75                         filter=schema, --exclude-filter=schema.implml,
       
    76                         --exclude-filter=schema.confml, --exclude-
       
    77                         filter=schema.implml.ruleml
       
    78     --include-filter=INCLUDE_FILTER
       
    79                         Include problems by given filter.Examples: --include-
       
    80                         filter=schema.implml, --include-
       
    81                         filter=schema.implml.ruleml