587
|
1 |
<#--
|
|
2 |
============================================================================
|
|
3 |
Name : stage_publishing.rst.inc.ftl
|
|
4 |
Part of : Helium
|
|
5 |
|
|
6 |
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
7 |
All rights reserved.
|
|
8 |
This component and the accompanying materials are made available
|
|
9 |
under the terms of the License "Eclipse Public License v1.0"
|
|
10 |
which accompanies this distribution, and is available
|
|
11 |
at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
12 |
|
|
13 |
Initial Contributors:
|
|
14 |
Nokia Corporation - initial contribution.
|
|
15 |
|
|
16 |
Contributors:
|
|
17 |
|
|
18 |
Description:
|
|
19 |
|
|
20 |
============================================================================
|
|
21 |
-->
|
|
22 |
|
|
23 |
.. index::
|
|
24 |
single: Stage - Publishing
|
|
25 |
|
|
26 |
Stage: Publishing
|
|
27 |
=================
|
|
28 |
|
|
29 |
.. index::
|
|
30 |
single: Uploading to Diamonds
|
|
31 |
|
|
32 |
Uploading build information to Diamonds
|
|
33 |
---------------------------------------
|
|
34 |
|
|
35 |
Diamonds is a utility tool that keeps track of build and release information. See the **Metrics** manual under section `Helium Configuration`_ for more info.
|
|
36 |
|
645
|
37 |
.. _Helium Configuration: metrics.html#helium-configuration
|
587
|
38 |
|
|
39 |
|
|
40 |
.. index::
|
|
41 |
single: Zipping Build area
|
|
42 |
|
|
43 |
Zipping of the build area
|
|
44 |
-------------------------
|
|
45 |
|
|
46 |
The Engineering English build area is archived in the :hlm-t:`zip-ee` target. Zipping of the localised build area is done by :hlm-t:`zip-localised` target. These properties need to be set:
|
|
47 |
|
|
48 |
:hlm-p:`zip.config.file`
|
|
49 |
Location of the config file.
|
|
50 |
|
|
51 |
:hlm-p:`zips.ee.spec.name`
|
|
52 |
Spec name for ee zipping (e.g. "ee").
|
|
53 |
|
|
54 |
:hlm-p:`zips.localised.spec.name`
|
|
55 |
Spec name for localised build area zipping (e.g. "localised").
|
|
56 |
|
|
57 |
The :hlm-p:`zip.config.file` property defines the path to a :ref:`common-configuration-format-label` file that defines the content of the zips created. It can consist of multiple configs, e.g.
|
|
58 |
|
|
59 |
.. code-block:: xml
|
|
60 |
|
|
61 |
<build>
|
|
62 |
<config name="ee" abstract="true">
|
|
63 |
<set name="max.uncompressed.size" value="2000000000"/>
|
|
64 |
<set name="max.files.per.archive" value="65000"/>
|
|
65 |
<set name="archive.tool" value="7za"/>
|
|
66 |
<set name="root.dir" value="${r'$'}{build.drive}\"/>
|
|
67 |
<set name="archives.dir" value="${r'$'}{build.output.dir}\build_area\engineering_english_test"/>
|
|
68 |
<set name="temp.build.dir" value="${r'$'}{temp.build.dir}"/>
|
|
69 |
<config>
|
|
70 |
<set name="name" value="${r'$'}{build.id}_dev_flashfiles"/>
|
|
71 |
<set name="include" value="output\development_flash_images\"/>
|
|
72 |
</config>
|
|
73 |
<config>
|
|
74 |
<set name="name" value="${r'$'}{build.id}_release_flashfiles"/>
|
|
75 |
<set name="include" value="output\release_flash_images\"/>
|
|
76 |
</config>
|
|
77 |
</config>
|
|
78 |
<config name="localised" abstract="true">
|
|
79 |
<set name="max.uncompressed.size" value="2000000000"/>
|
|
80 |
<set name="max.files.per.archive" value="65000"/>
|
|
81 |
<set name="archive.tool" value="7za"/>
|
|
82 |
<set name="root.dir" value="${r'$'}{build.drive}\"/>
|
|
83 |
|
|
84 |
<set name="archives.dir" value="${r'$'}{build.output.dir}\build_area\localised"/>
|
|
85 |
<set name="temp.build.dir" value="${r'$'}{temp.build.dir}"/>
|
|
86 |
|
|
87 |
<config>
|
|
88 |
<set name="name" value="${r'$'}{build.id}_dev_flashfiles_ee"/>
|
|
89 |
<set name="include" value="output\development_flash_images\engineering_english\"/>
|
|
90 |
</config>
|
|
91 |
|
|
92 |
<config>
|
|
93 |
<set name="name" value="${r'$'}{build.id}_dev_flashfiles_localised"/>
|
|
94 |
<set name="include" value="output\development_flash_images\localised\"/>
|
|
95 |
</config>
|
|
96 |
</config>
|
|
97 |
</config>
|
|
98 |
|
|
99 |
<config name="policy">
|
|
100 |
<config>
|
|
101 |
<set name="name" value="${r'$'}{build.id}_dev_flashfiles"/>
|
|
102 |
<set name="include" value="output\development_flash_images\"/>
|
|
103 |
<set name="mapper" value="policy"/>
|
|
104 |
<set name="policy.internal.name" value="really_confidential_stuff"/>
|
|
105 |
<set name="policy.filenames" value="Distribution.Policy.S60"/>
|
645
|
106 |
<set name="split.on.uncompressed.size.enabled" value="true"/>
|
587
|
107 |
</config>
|
|
108 |
</config>
|
|
109 |
|
|
110 |
<config name="policy.remover">
|
|
111 |
<config>
|
|
112 |
<set name="name" value="${r'$'}{build.id}_s60_osext"/>
|
|
113 |
<set name="include" value="s60\osext\"/>
|
|
114 |
<set name="mapper" value="policy.remover"/>
|
|
115 |
<set name="policy.internal.name" value="really_confidential_stuff"/>
|
|
116 |
<set name="policy.filenames" value="Distribution.Policy.S60"/>
|
|
117 |
<set name="policy.root.dir" value="${r'$'}{root.dir}/s60"/>
|
645
|
118 |
<set name="split.on.uncompressed.size.enabled" value="true"/>
|
587
|
119 |
</config>
|
|
120 |
</config>
|
|
121 |
|
|
122 |
<config name="scanner">
|
|
123 |
<config>
|
|
124 |
<set name="name" value="${r'$'}{build.id}_dev_flashfiles"/>
|
|
125 |
<set name="scanners" value="abld.what"/>
|
|
126 |
<set name="abld.buildpath" value="path/to/component/group"/>
|
|
127 |
<set name="exclude" value="**/*.dll"/>
|
|
128 |
<set name="exclude.lst" value="${r'$'}{build.drive}/exclude.lst"/>
|
|
129 |
</config>
|
|
130 |
</config>
|
|
131 |
|
|
132 |
</build>
|
|
133 |
|
|
134 |
|
|
135 |
|
|
136 |
.. csv-table:: Common property descriptions
|
|
137 |
:header: "Property", "Description", "Values"
|
|
138 |
|
|
139 |
"``temp.build.dir``", "Directory to store temporary files generated during the process.", ""
|
|
140 |
"``name``", "The name of the zip file.", ""
|
|
141 |
|
|
142 |
|
|
143 |
.. csv-table:: File System scanner property descriptions (default)
|
|
144 |
:header: "Property", "Description", "Values"
|
|
145 |
|
|
146 |
"``include``", "Path to include files/directories in the zip. Follows the Ant fileset convention.", ""
|
|
147 |
"``exclude``", "Path to exclude files/directories in the zip. Follows the Ant fileset convention.", ""
|
|
148 |
"``exclude.lst``", "Location of a file containing an exclude list(one pattern per line).", ""
|
|
149 |
"``distribution.policy.s60``", "Defines that the included files will be filtered based on the value of the ``Distribution.Policy.S60`` files. The file found closest to the root will override those in subdirectories.", "The value found in the file, e.g. 0 or 1. This can be negated by putting a '!' in front."
|
|
150 |
|
|
151 |
|
|
152 |
.. csv-table:: Abld 'what' scanner property descriptions (abld.what)
|
|
153 |
:header: "Property", "Description", "Values"
|
|
154 |
|
|
155 |
"``exclude``", "Path to exclude files/directories in the zip. Follows the Ant fileset convention.", ""
|
|
156 |
"``exclude.lst``", "Location of a file containing an exclude list(one pattern per line).", ""
|
|
157 |
"``abld.buildpath``", "The path to an bld.inf directory. The files built from this component will be included.", ""
|
|
158 |
"``abld.type``", "For what platform should abld be run for.", "armv5"
|
|
159 |
"``abld.epocroot``", "To specify an EPOCROOT other than \\.", ""
|
|
160 |
|
|
161 |
|
|
162 |
.. csv-table:: Default Mappers property description (default)
|
|
163 |
:header: "Property", "Description", "Values"
|
|
164 |
|
|
165 |
"``name``", "The name of the zip file.", ""
|
|
166 |
"``max.uncompressed.size``", "Maximum size in bytes of the content being included in each zip file. If the included content exceeds this, multiple zips will be created.", ""
|
|
167 |
"``max.files.per.archive``", "Maximum number of files that can be included in an archive. If the total exceeds this, multiple zips will be created.", ""
|
|
168 |
"``archive.tool``", "The command-line archiving tool. 7zip and zip are supported.", "7za, zip"
|
|
169 |
"``root.dir``", "The root directory of the content being zipped.", ""
|
|
170 |
"``archives.dir``", "The directory where the zip files are saved to.", ""
|
|
171 |
"``zip.root.dir``", "The root directory for the content inside the zip file.", "root.dir value"
|
|
172 |
|
|
173 |
|
|
174 |
.. csv-table:: Policy Mappers property description (policy)
|
|
175 |
:header: "Property", "Description", "Values"
|
|
176 |
|
|
177 |
"``name``", "The name of the zip file.", ""
|
|
178 |
"``policy.internal.name``", "Suffix of the archive that contains the confidential content.", "internal"
|
|
179 |
"``policy.filenames``", "Comma separated list of policy filename.", "Distribution.Policy.S60"
|
|
180 |
"``archive.tool``", "The command-line archiving tool. 7zip and zip are supported.", "7za, zip"
|
|
181 |
"``archives.dir``", "The directory where the zip files are saved to.", ""
|
|
182 |
"``policy.csv``", "This property defines the location of the policy definition file.", ""
|
|
183 |
"``policy.default.value``", "This property defines the policy value when policy file is missing or invalid (e.g. wrong format).", "9999"
|
645
|
184 |
"``split.on.uncompressed.size.enabled``", "To enable/disable splitting the zip files depending on source file size.", "true/false"
|
|
185 |
|
587
|
186 |
|
|
187 |
The policy mapper enables the sorting of the content compare to its policy value. The mapper is looking for a policy file in the file to archive directory.
|
|
188 |
If the distribution policy file is missing then the file will go to the ``policy.default.value`` archive. Else it tries to open the file which
|
|
189 |
MUST be ASCII encoded, and have its content matching the following expression: ``^\\d+\\s*$``.
|
|
190 |
File not matching those specifications will be reported as invalid and the assiociated content will go to the ``policy.default.value`` archive.
|
|
191 |
|
|
192 |
Archive filenames are generated the following way:
|
|
193 |
|
|
194 |
Policy value is 0::
|
|
195 |
|
|
196 |
${r'$'}{archive.dir}/${r'$'}{name}.zip
|
|
197 |
|
|
198 |
Policy value is different from 0::
|
|
199 |
|
|
200 |
${r'$'}{archive.dir}/${r'$'}{name}_${r'$'}{policy.internal.name}_<policy_value>.zip
|
|
201 |
|
|
202 |
If the policy file is missing or its content is invalid ot the olicy value is not found in the ``${r'$'}{policy.csv}``::
|
|
203 |
|
|
204 |
${r'$'}{archive.dir}/${r'$'}{name}_${r'$'}{policy.internal.name}_${r'$'}{policy.default.value}.zip
|
|
205 |
|
|
206 |
|
|
207 |
.. csv-table:: Policy Remover Mappers property description (policy)
|
|
208 |
:header: "Property", "Description", "Values"
|
|
209 |
|
|
210 |
"``name``", "The name of the zip file.", ""
|
|
211 |
"``policy.internal.name``", "Suffix of the archive that contains the confidential content.", "internal"
|
|
212 |
"``policy.filenames``", "Comma separated list of policy filename.", "Distribution.Policy.S60"
|
|
213 |
"``archive.tool``", "The command-line archiving tool. 7zip and zip are supported.", "7za, zip"
|
|
214 |
"``archives.dir``", "The directory where the zip files are saved to.", ""
|
|
215 |
"``policy.root.dir``", "This property allows the user to restrict the root of policy scanning.", "root.dir value"
|
|
216 |
"``policy.default.value``", "This property defines the policy value when policy file is missing or invalid (e.g. wrong format).", "9999"
|
|
217 |
|
|
218 |
The remover mapper in addition to policy mapper behaviour will remove the content not required for the build.
|
|
219 |
The removal process is based on the policy.csv file information, content will be kept in the following cases:
|
|
220 |
|
|
221 |
* Included in build column is ``yes``
|
|
222 |
* Included in build column is ``bin``
|
|
223 |
|
|
224 |
|
|
225 |
Two additionals removers have been introduced to support action from SFL and EPL column, you use the following
|
|
226 |
named mappers to use them:
|
|
227 |
|
|
228 |
* ``sfl.policy.remover`` based on the 4th column of the csv
|
|
229 |
* ``epl.policy.remover`` based on the 5th column of the csv
|
|
230 |
|
|
231 |
They support the same set of configuration properties as the default ``policy.remover``.
|
|
232 |
|
645
|
233 |
<#if !ant?keys?seq_contains("sf")>
|
|
234 |
.. include:: stage_metadata.rst.inc
|
|
235 |
</#if>
|
587
|
236 |
|
|
237 |
.. index::
|
|
238 |
single: Zipping SUBCON
|
|
239 |
|
|
240 |
Subcon zipping
|
|
241 |
--------------
|
|
242 |
|
645
|
243 |
Subcon zipping is also configured using the same XML format as :hlm-t:`zip-ee` and implemented in the :hlm-t:`zip-subcon` target. A ``zips.subcon.spec.name`` property must be defined but currently it is still a separate configuration file.
|
|
244 |
|
587
|
245 |
|
645
|
246 |
Stage: Blocks packaging
|
|
247 |
=======================
|
|
248 |
|
|
249 |
Refer to the `Blocks integration manual`_
|
|
250 |
|
|
251 |
.. _`Blocks intergration manual`: blocks.html
|