1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html lang="en" xmlns:v="urn:schemas-microsoft-com:vml"
3
xmlns:o="urn:schemas-microsoft-com:office:office"
4
xmlns:w="urn:schemas-microsoft-com:office:word"
5
xmlns="http://www.w3.org/TR/REC-html40">
8
<meta http-equiv=Content-Type content="text/html; charset=ISO-8859-1">
9
<meta name=ProgId content=Word.Document>
10
<meta name=Generator content="Microsoft Word 10">
11
<meta name=Originator content="Microsoft Word 10">
15
v\:* {behavior:url(#default#VML);}
16
o\:* {behavior:url(#default#VML);}
17
w\:* {behavior:url(#default#VML);}
18
.shape {behavior:url(#default#VML);}
21
<title>Versioning pre-built indexes</title>
22
<!--[if gte mso 9]><xml>
25
<w:SpellingState>Clean</w:SpellingState>
26
<w:GrammarState>Clean</w:GrammarState>
27
<w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>
32
/* Style Definitions */
33
p.MsoNormal, li.MsoNormal, div.MsoNormal
36
margin-bottom:.0001pt;
37
mso-pagination:widow-orphan;
39
font-family:"Times New Roman";
40
mso-fareast-font-family:"Times New Roman";}
42
{mso-style-next:Normal;
47
mso-pagination:widow-orphan;
48
page-break-after:avoid;
52
mso-font-kerning:16.0pt;}
54
{mso-style-next:Normal;
59
mso-pagination:widow-orphan;
60
page-break-after:avoid;
65
a:link, span.MsoHyperlink
67
text-decoration:underline;
68
text-underline:single;}
69
a:visited, span.MsoHyperlinkFollowed
71
text-decoration:underline;
72
text-underline:single;}
80
{size:612.0pt 792.0pt;
81
margin:72.0pt 90.0pt 72.0pt 90.0pt;
82
mso-header-margin:35.4pt;
83
mso-footer-margin:35.4pt;
91
/* Style Definitions */
93
{mso-style-name:"Table Normal";
94
mso-tstyle-rowband-size:0;
95
mso-tstyle-colband-size:0;
98
mso-padding-alt:0cm 5.4pt 0cm 5.4pt;
100
mso-para-margin-bottom:.0001pt;
101
mso-pagination:widow-orphan;
103
font-family:"Times New Roman";}
105
<![endif]--><!--[if gte mso 9]><xml>
106
<o:shapedefaults v:ext="edit" spidmax="3074"/>
107
</xml><![endif]--><!--[if gte mso 9]><xml>
108
<o:shapelayout v:ext="edit">
109
<o:idmap v:ext="edit" data="1"/>
110
</o:shapelayout></xml><![endif]-->
113
<body lang=EN-GB link=blue vlink="#606420" style='tab-interval:36.0pt'>
117
<h1 align=center style='text-align:center'>Versioning of pre-built indexes</h1>
119
<p class=MsoNormal> </p>
121
<p class=MsoNormal style='text-align:justify'>In CDT 4.0.1 support for
122
versioning of pre-built indexes was added. This means that if you release
123
pre-built indexes for the same content (for example, the same SDK version), but
124
they were built with different versions of CDT, then a suitable version will
125
now be used automatically. The previous behaviour assumed only one format
126
version of any particular content would be provided via the <span class=SpellE>CIndex</span>
129
<p class=MsoNormal style='text-align:justify'> </p>
131
<p class=MsoNormal style='text-align:justify'>It is important to distinguish
132
between two versions: the content version and the index format version. A
133
content version refers to the version of the source code being indexed
134
independent of how it is represented in the index e.g. SDK v1.0 and SDK v1.2.
135
The index format version is the version of the internal representation of the
136
index. This document is about coping with the latter.</p>
138
<p class=MsoNormal style='text-align:justify'> </p>
140
<p class=MsoNormal style='text-align:justify'>Our versioning policy for index
141
formats is that they should be compatible within major (yearly) release
142
versions. That is if you build an index using CDT 4.0.X it should work with CDT
143
4.0.Y. This policy should mean that ISVs do not need to worry about index
144
format versioning, but this page describes how to handle it should it be
145
necessary (for example <span class=SpellE>bugzilla</span> 189811).Each
146
pre-built index carries a string ID which identifies it uniquely within a
147
logical index - i.e. it identifies the content (<span class=SpellE>e.g</span> <span
148
class=SpellE>MySDK</span> v1.2). When multiple pre-built indexes are provided
149
with the same ID, the particular one for use is disambiguated automatically by
150
CDT which chooses the most recent compatible version.</p>
152
<h2><span style='font-style:normal;mso-bidi-font-style:italic'>Compatibility
153
Table<o:p></o:p></span></h2>
155
<p class=MsoNormal> </p>
157
<p class=MsoNormal style='text-align:justify'>This table shows the
158
compatibility of pre-built indexes built with one version of CDT and used with
159
another. �Built With� is the vertical axis.</p>
161
<p class=MsoNormal> </p>
163
<table class=MsoNormalTable border=0 cellspacing=0 cellpadding=0 width=516
164
style='width:387.0pt;margin-left:23.4pt;border-collapse:collapse;mso-padding-alt:
166
<tr style='mso-yfti-irow:0'>
167
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
168
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
169
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
170
<span class=MsoNormal><strong><span style='font-size:8.0pt'>Built With \ Use With</span></strong></span>
172
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
173
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
174
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
175
<p class=MsoNormal>CDT 4.0</p>
177
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
178
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
179
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
180
<p class=MsoNormal>CDT 4.0.1</p>
182
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
183
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
184
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
185
<p class=MsoNormal>CDT Next**</p>
187
<td width=44 valign=top style='width:32.8pt;border:none;border-bottom:solid white 2.25pt;
188
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
189
<span class=MsoNormal><strong> </strong></span>
192
<tr style='mso-yfti-irow:1'>
193
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
194
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
195
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
196
<p class=MsoNormal>CDT 4.0</p>
198
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
199
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
200
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
201
<p class=MsoNormal>Yes*</p>
203
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
204
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
205
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
206
<p class=MsoNormal>Yes*</p>
208
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
209
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
210
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
211
<p class=MsoNormal>No</p>
213
<td width=44 valign=top style='width:32.8pt;border:none;border-bottom:solid white 2.25pt;
214
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
215
<p class=MsoNormal> </p>
218
<tr style='mso-yfti-irow:2'>
219
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
220
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
221
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
222
<p class=MsoNormal>CDT 4.0.1</p>
224
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
225
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
226
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
227
<p class=MsoNormal>Yes*</p>
229
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
230
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
231
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
232
<p class=MsoNormal>Yes</p>
234
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
235
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
236
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
237
<p class=MsoNormal>No</p>
239
<td width=44 valign=top style='width:32.8pt;border:none;border-bottom:solid white 2.25pt;
240
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
241
<p class=MsoNormal> </p>
244
<tr style='mso-yfti-irow:3'>
245
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
246
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
247
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
248
<p class=MsoNormal>CDT Next**</p>
250
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
251
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
252
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
253
<p class=MsoNormal>No</p>
255
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
256
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
257
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
258
<p class=MsoNormal>No</p>
260
<td width=118 valign=top style='width:88.55pt;border-top:none;border-left:
261
none;border-bottom:solid white 2.25pt;border-right:solid white 2.25pt;
262
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
263
<p class=MsoNormal>Yes</p>
265
<td width=44 valign=top style='width:32.8pt;border:none;border-bottom:solid white 2.25pt;
266
background:#F2F2F2;padding:0cm 5.4pt 0cm 5.4pt'>
267
<p class=MsoNormal> </p>
270
<tr style='mso-yfti-irow:4;mso-yfti-lastrow:yes'>
271
<td width=118 valign=top style='width:88.55pt;border:none;border-right:solid white 2.25pt;
272
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
273
<p class=MsoNormal> </p>
275
<td width=118 valign=top style='width:88.55pt;border:none;border-right:solid white 2.25pt;
276
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
277
<p class=MsoNormal> </p>
279
<td width=118 valign=top style='width:88.55pt;border:none;border-right:solid white 2.25pt;
280
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
281
<p class=MsoNormal> </p>
283
<td width=118 valign=top style='width:88.55pt;border:none;border-right:solid white 2.25pt;
284
background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
285
<p class=MsoNormal> </p>
287
<td width=44 valign=top style='width:32.8pt;background:#CCCCCC;padding:0cm 5.4pt 0cm 5.4pt'>
288
<p class=MsoNormal> </p>
293
<p class=MsoNormal> </p>
295
<p class=MsoNormal style='text-align:justify'>Note that even though in the PDOM
296
format has its own internal versioning scheme, consumers of official CDT
297
releases need only be aware of compatibility constraints between these
300
<p class=MsoNormal> </p>
302
<p class=MsoNormal><span style='font-size:8.0pt'>* <span class=GramE>with</span>
303
performance issues in very large projects. See <a
304
href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=189811">https://bugs.eclipse.org/bugs/show_bug.cgi?id=189811</a></span></p>
306
<p class=MsoNormal><span class=GramE><span style='font-size:8.0pt'>** represents
307
the next major release of CDT.</span></span><span style='font-size:8.0pt'> It
308
is assumed significant changes to the PDOM database will occur.<o:p></o:p></span></p>
310
<p class=MsoNormal><span style='font-size:8.0pt'><o:p> </o:p></span></p>
312
<h2><span style='font-style:normal;mso-bidi-font-style:italic'>Example scenario<o:p></o:p></span></h2>
314
<p class=MsoNormal><o:p> </o:p></p>
316
<span style='font-size:12.0pt;font-family:"Times New Roman";mso-fareast-font-family:
317
"Times New Roman";mso-ansi-language:EN-GB;mso-fareast-language:EN-GB;
318
mso-bidi-language:AR-SA'><br clear=all style='page-break-before:always'>
321
<p class=MsoNormal align=center style='text-align:center'> </p>
323
<p class=MsoNormal align=center style='text-align:center'><img border=0
324
width=421 height=653 id="_x0000_i1025"
325
src="prebuiltVersioning_files/image001.jpg" alt="example scenario"></p>
327
<p class=MsoNormal align=center style='text-align:center'> </p>
329
<p class=MsoNormal style='text-align:justify'>The figure above shows an example
330
scenario where pre-built indexes are contributed by multiple <span class=GramE>plug-ins</span>.
331
The same content is contributed in multiple index format versions. The versions
332
selected for use by each version of CDT are highlighted in <span class=SpellE>gray</span>.</p>
334
<p class=MsoNormal style='text-align:justify'><o:p> </o:p></p>
336
<p class=MsoNormal style='text-align:justify'><o:p> </o:p></p>
338
<p class=MsoNormal style='text-align:justify'><o:p> </o:p></p>
340
<p class=MsoNormal><span style='font-size:10.0pt'>Versioning <span
341
class=SpellE>Bugzilla</span>: <a
342
href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=196338">https://bugs.eclipse.org/bugs/show_bug.cgi?id=196338</a></span></p>
344
<p class=MsoNormal style='text-align:justify'><o:p> </o:p></p>