|
1 ConE initvariant action |
|
2 ======================= |
|
3 |
|
4 The *initvariant* action is intended for merging a variant CPF back into the |
|
5 configuration project. It is basically a special-purpose merge action that |
|
6 merges all customer variant layers (layers with ``custvariant*`` in their path |
|
7 name) and renames them based on the given variant ID and variant name |
|
8 (``custvariant_<id>_<name>``). |
|
9 |
|
10 Examples |
|
11 -------- |
|
12 |
|
13 **Merging a variant CPF using variant ID and name**:: |
|
14 |
|
15 > cd configproject_root |
|
16 > cone initvariant -r variant.cpf --variant-id 123 --variant-name foobar |
|
17 |
|
18 This will merge customer variant layers into the project. The configuration |
|
19 root into which they are merged is also determined automatically based on the |
|
20 supplied information. The automatically determined root file is named |
|
21 ``<product-name>_custvariant_<variant-id>_<variant-name>_root.confml``, |
|
22 and the merged layers will have ``custvariant_<variant-id>_<variant-name>`` |
|
23 as part of their layer path. |
|
24 E.g. the layer ``familyx/productx/customer/custvariant/configurator/root.confml`` |
|
25 is merged as ``familyx/productx/customer/custvariant_123_foobar/configurator/root.confml`` |
|
26 and the configuration root would be ``productx_custvariant_123_foobar_root.confml``. |
|
27 |
|
28 **Merging a variant CPF into a specific root file**:: |
|
29 |
|
30 > cd configproject_root |
|
31 > cone initvariant -r variant.cpf --variant-id 123 -c foovariant.confml |
|
32 |
|
33 This does basically the same thing as the previous command, except that the |
|
34 configuration root into which the merge is done is explicitly specified. Also, |
|
35 the optional argument ``--variant-name`` is missing, so the layers will be merged |
|
36 as ``custvariant_<variant-id>``. |
|
37 |
|
38 Options list |
|
39 ------------ |
|
40 --version show program's version number and exit |
|
41 -h, --help show this help message and exit |
|
42 --print-settings Print all the default settings from the current |
|
43 setting container. |
|
44 --print-supported-impls |
|
45 Print all supported ImplML XML namespaces and file |
|
46 extensions. |
|
47 --print-runtime-info Print runtime information about ConE. |
|
48 -v LEVEL, --verbose=LEVEL |
|
49 Print error, warning and information on system out. |
|
50 Possible choices: Default is 3. |
|
51 NONE (all) 0 |
|
52 CRITICAL 1 |
|
53 ERROR 2 |
|
54 WARNING 3 |
|
55 INFO 4 |
|
56 DEBUG 5 |
|
57 --log-file=FILE Location of the used log file. Default is 'cone.log' |
|
58 --log-config=FILE Location of the used logging configuration file. |
|
59 Default is 'logging.ini' |
|
60 --username=USERNAME Username for webstorage operations. Not needed for |
|
61 filestorage or cpf storage. If the username |
|
62 is not given, the tool will use the logged in |
|
63 username. Example: cone export -p webstorage_url -r . |
|
64 -c sample.confml --username=admin --password=abc123. |
|
65 --password=PASSWORD Password for webstorage operations. Not needed for |
|
66 filestorage or cpf storage. If the password |
|
67 is not given, the tool will prompt for password if |
|
68 needed. |
|
69 -p STORAGE, --project=STORAGE |
|
70 Defines the location of current project. Default is |
|
71 the current working directory. |
|
72 |
|
73 Initvariant options: |
|
74 The initvariant action is intended for merging a variant CPF back into |
|
75 the configuration project. It merges all customer variant layers |
|
76 (layers with custvariant* in their path name) and renames them based |
|
77 on the variant ID and variant name ("custvariant_<id>_<name>"). |
|
78 |
|
79 -c CONFIG, --configuration=CONFIG |
|
80 Defines the name of the target configuration. By |
|
81 default the configuration file name is composed of |
|
82 product name, variant ID and variant name like this: |
|
83 <product>_custvariant_<id>_<name>_root.confml |
|
84 -r STORAGE, --remote=STORAGE |
|
85 Defines the location of remote storage (CPF) |
|
86 -s CONFIG, --sourceconfiguration=CONFIG |
|
87 Defines the name of the remote configuration inside |
|
88 the remote storage. Default is the active root of the |
|
89 remote project. |
|
90 --variant-id=VARIANT_ID |
|
91 Variant ID, mandatory. |
|
92 --variant-name=VARIANT_NAME |
|
93 Variant name, optional. |
|
94 --product-name=PRODUCT_NAME |
|
95 Product name, taken from the configuration data by |
|
96 default (i.e. defaults to '${imakerapi.productname}') |
|
97 --set-active-root Set the newly created (or merged) configuration root |
|
98 as the project's active root after the merge is done. |