Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / abi-compliance-checker / refs/tags/20.12.0-beta.1 / . / doc / Xml-Descriptor.html
blob: ca9c392f317a6fe3872b2c2317c6d7f1c66ff8f8 [file] [log] [blame]
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <meta name="description" content="XML Descriptor" />
6 <title>XML Descriptor</title>
7
8 <style type="text/css">
9 body {
10 margin-top: 1.0em;
11 background-color: #deeef7;
12 font-family: Helvetica, Arial, FreeSans, san-serif;
13 color: #000000;
14 }
15 #container {
16 margin: 0 auto;
17 width: 700px;
18 }
19 h1 { font-size: 3.8em; color: #211108; margin-bottom: 3px;margin-top:0px;padding-top:0px;}
20 h1 .small { font-size: 0.4em; }
21 h1 a { text-decoration: none }
22 h2 { font-size: 1.5em; color: #211108; }
23 h3 { text-align: center; color: #211108; }
24 a { color: #211108; }
25 .description { font-size: 1.2em; margin-bottom: 30px; margin-top: 30px; font-style: italic;}
26 .download { float: right; }
27 pre {padding: 0px;margin: 0px;padding-left: 10px;word-wrap:break-word;white-space: pre-wrap;}
28 hr { border: 0; width: 80%; border-bottom: 1px solid #aaa}
29 .footer { text-align: center; padding-top:30px; font-style: italic; }
30 .code {border: dashed 1px gray; background-color: #f0f0f0;}
31 .listing {padding: 10px;border: 1px solid black;width: 70%;font-family:"DejaVu Sans Mono", "Monaco", "Courier New", monospace;font-size:14px;}
32 .summary {border:1px solid black;border-collapse:collapse;}
33 table.summary td, table.summary th {border:1px solid black;padding: 4px;}
34 .ext {color: Brown;font-weight: bold;}
35 </style>
36
37</head>
38
39<body>
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]40<a href="https://github.com/lvc/abi-compliance-checker"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]41
42<div id="container">
43
44<h1>XML-Descriptor</h1>
45<p/>
46The library descriptor is a simple XML-file that specifies version number, paths to header files and shared libraries and optionally some other information.
47<p/>
48
49<table class='summary'><tr><td>
50<div>Table of Contents</div>
51<ul>
52<li><a href="#Primary">Primary Sections</a></li>
53<li><a href="#Optional">Optional Sections</a></li>
54<li><a href="#Examples">Examples</a></li>
55</ul>
56</td></tr></table>
57
58<a name="Primary"></a>
59<h2>Primary Sections</h2>
60<div class='listing'>
61<pre>
62<span style='color:Green;'>&lt;version&gt;</span>
63 /* Version of the library */
64<span style='color:Green;'>&lt;/version&gt;</span>
65
66<span style='color:Green;'>&lt;headers&gt;</span>
67 /* The list of paths to header files or/and
68 directories with header files, one per line */
69<span style='color:Green;'>&lt;/headers&gt;</span>
70
71<span style='color:Green;'>&lt;libs&gt;</span>
72 /* The list of paths to shared libraries or/and
73 directories with shared libraries, one per line */
74<span style='color:Green;'>&lt;/libs&gt;</span>
75</pre>
76</div>
77<p/>
78
79<a name="Optional"></a>
80<h2>Optional Sections</h2>
81<div class='listing'>
82<pre>
83<span style='color:Green;'>&lt;include_paths&gt;</span>
84 /* The list of paths to be searched for header files
85 needed for compiling of library headers, one per
86 line. NOTE: If you define this section then the tool
87 will not automatically detect include paths */
88<span style='color:Green;'>&lt;/include_paths&gt;</span>
89
90<span style='color:Green;'>&lt;add_include_paths&gt;</span>
91 /* The list of include paths that should be added
92 to the automatically detected include paths, one per
93 line */
94<span style='color:Green;'>&lt;/add_include_paths&gt;</span>
95
96<span style='color:Green;'>&lt;skip_include_paths&gt;</span>
97 /* The list of include paths that will be removed from
98 the list of automatically generated include paths, one
99 per line */
100<span style='color:Green;'>&lt;/skip_include_paths&gt;</span>
101
102<span style='color:Green;'>&lt;gcc_options&gt;</span>
103 /* Additional GCC options, one per line */
104<span style='color:Green;'>&lt;/gcc_options&gt;</span>
105
106<span style='color:Green;'>&lt;include_preamble&gt;</span>
107 /* The list of header files that should be included
108 before other headers, one per line. For example, it
109 is a tree.h for libxml2 and ft2build.h for freetype2
110 library */
111<span style='color:Green;'>&lt;/include_preamble&gt;</span>
112
113<span style='color:Green;'>&lt;defines&gt;</span>
114 /* Add defines at the headers compiling stage, one per
115 line:
116 #define A B
117 #define C D */
118<span style='color:Green;'>&lt;/defines&gt;</span>
119
120<span style='color:Green;'>&lt;add_namespaces&gt;</span>
121 /* The list of namespaces that should be added to the
122 alanysis if the tool cannot find them automatically,
123 one per line */
124<span style='color:Green;'>&lt;/add_namespaces&gt;</span>
125
126<span style='color:Green;'>&lt;skip_types&gt;</span>
127 /* The list of data types, that
128 should not be checked, one per line */
129<span style='color:Green;'>&lt;/skip_types&gt;</span>
130
131<span style='color:Green;'>&lt;skip_symbols&gt;</span>
132 /* The list of functions (mangled/symbol names in C++),
133 that should not be checked, one per line */
134<span style='color:Green;'>&lt;/skip_symbols&gt;</span>
135
136<span style='color:Green;'>&lt;skip_namespaces&gt;</span>
137 /* The list of C++ namespaces, that
138 should not be checked, one per line */
139<span style='color:Green;'>&lt;/skip_namespaces&gt;</span>
140
141<span style='color:Green;'>&lt;skip_constants&gt;</span>
142 /* The list of constants that should not be checked,
143 one name per line */
144<span style='color:Green;'>&lt;/skip_constants&gt;</span>
145
146<span style='color:Green;'>&lt;skip_headers&gt;</span>
147 /* The list of header files and/or directories
148 with header files that should not be checked, one per
149 line */
150<span style='color:Green;'>&lt;/skip_headers&gt;</span>
151
152<span style='color:Green;'>&lt;skip_libs&gt;</span>
153 /* The list of shared libraries and/or directories
154 with shared libraries that should not be checked, one
155 per line */
156<span style='color:Green;'>&lt;/skip_libs&gt;</span>
157
158<span style='color:Green;'>&lt;skip_including&gt;</span>
159 /* The list of header files, that cannot be included
160 directly (or non-self compiled ones), one per line */
161<span style='color:Green;'>&lt;/skip_including&gt;</span>
162
163<span style='color:Green;'>&lt;search_headers&gt;</span>
164 /* List of directories to be searched
165 for header files to automatically
166 generate include paths, one per line */
167<span style='color:Green;'>&lt;/search_headers&gt;</span>
168
169<span style='color:Green;'>&lt;search_libs&gt;</span>
170 /* List of directories to be searched
171 for shared librariess to resolve
172 dependencies, one per line */
173<span style='color:Green;'>&lt;/search_libs&gt;</span>
174
175<span style='color:Green;'>&lt;tools&gt;</span>
176 /* List of directories with tools used
177 for analysis (GCC toolchain), one per line */
178<span style='color:Green;'>&lt;/tools&gt;</span>
179
180<span style='color:Green;'>&lt;cross_prefix&gt;</span>
181 /* GCC toolchain prefix.
182 Examples:
183 arm-linux-gnueabi
184 arm-none-symbianelf */
185<span style='color:Green;'>&lt;/cross_prefix&gt;</span>
186</pre>
187</div>
188<p/>
189
190<a name="Examples"></a>
191<h2>Examples</h2>
192
193libssh:
194<div class='listing'>
195<pre>
196<span style='color:Green;'>&lt;version&gt;</span>
197 0.3.4
198<span style='color:Green;'>&lt;/version&gt;</span>
199
200<span style='color:Green;'>&lt;headers&gt;</span>
201 /usr/local/libssh/0.3.4/include/
202<span style='color:Green;'>&lt;/headers&gt;</span>
203
204<span style='color:Green;'>&lt;libs&gt;</span>
205 /usr/local/libssh/0.3.4/lib/
206<span style='color:Green;'>&lt;/libs&gt;</span>
207</pre>
208</div>
209<p/>
210
211atk:
212<div class='listing'>
213<pre>
214<span style='color:Green;'>&lt;version&gt;</span>
215 1.28.0
216<span style='color:Green;'>&lt;/version&gt;</span>
217
218<span style='color:Green;'>&lt;headers&gt;</span>
219 /usr/local/atk-1.28.0/include/atk-1.0/atk/atk.h
220<span style='color:Green;'>&lt;/headers&gt;</span>
221
222<span style='color:Green;'>&lt;libs&gt;</span>
223 /usr/local/atk-1.28.0/lib/
224<span style='color:Green;'>&lt;/libs&gt;</span>
225
226<span style='color:Green;'>&lt;include_paths&gt;</span>
227 /usr/include/glib-2.0/
228 /usr/lib/glib-2.0/include/
229<span style='color:Green;'>&lt;/include_paths&gt;</span>
230</pre>
231</div>
232<p/>
233
234libxml2:
235<div class='listing'>
236<pre>
237<span style='color:Green;'>&lt;version&gt;</span>
238 2.7.6
239<span style='color:Green;'>&lt;/version&gt;</span>
240
241<span style='color:Green;'>&lt;headers&gt;</span>
242 /usr/local/libxml2-2.7.6/include/
243<span style='color:Green;'>&lt;/headers&gt;</span>
244
245<span style='color:Green;'>&lt;libs&gt;</span>
246 /usr/local/libxml2-2.7.6/lib/libxml2.so.2.7.6
247<span style='color:Green;'>&lt;/libs&gt;</span>
248
249<span style='color:Green;'>&lt;include_preamble&gt;</span>
250 tree.h
251<span style='color:Green;'>&lt;/include_preamble&gt;</span>
252</pre>
253</div>
254<p/>
255
256libX11:
257<div class='listing'>
258<pre>
259<span style='color:Green;'>&lt;version&gt;</span>
260 1.3.2
261<span style='color:Green;'>&lt;/version&gt;</span>
262
263<span style='color:Green;'>&lt;headers&gt;</span>
264 /usr/local/libX11-1.3.2/include/
265<span style='color:Green;'>&lt;/headers&gt;</span>
266
267<span style='color:Green;'>&lt;libs&gt;</span>
268 /usr/local/libX11-1.3.2/lib/
269<span style='color:Green;'>&lt;/libs&gt;</span>
270
271<span style='color:Green;'>&lt;include_preamble&gt;</span>
272 Xlib.h
273<span style='color:Green;'>&lt;/include_preamble&gt;</span>
274</pre>
275</div>
276<p/>
277
278BlackBerry 10 Native SDK:
279<div class='listing'>
280<pre>
281<span style='color:Green;'>&lt;version&gt;</span>
282 10
283<span style='color:Green;'>&lt;/version&gt;</span>
284
285<span style='color:Green;'>&lt;headers&gt;</span>
286 /home/RIM/bbndk/target_10_0_9_1673/qnx6/usr/include/bb/
287<span style='color:Green;'>&lt;/headers&gt;</span>
288
289<span style='color:Green;'>&lt;search_headers&gt;</span>
290 /home/RIM/bbndk/target_10_0_9_1673/qnx6/usr/include/
291<span style='color:Green;'>&lt;/search_headers&gt;</span>
292
293<span style='color:Green;'>&lt;libs&gt;</span>
294 /home/RIM/bbndk/target_10_0_9_1673/qnx6/x86/usr/lib/
295<span style='color:Green;'>&lt;/libs&gt;</span>
296
297<span style='color:Green;'>&lt;tools&gt;</span>
298 /home/RIM/bbndk/host_10_0_9_404/linux/x86/usr/bin/
299<span style='color:Green;'>&lt;/tools&gt;</span>
300
301<span style='color:Green;'>&lt;cross_prefix&gt;</span>
302 i486-pc-nto-qnx8.0.0
303<span style='color:Green;'>&lt;/cross_prefix&gt;</span>
304</pre>
305</div>
306<p/>
307
308libQt5Core:
309<div class='listing'>
310<pre>
311<span style='color:Green;'>&lt;version&gt;</span>
312 5.5.0
313<span style='color:Green;'>&lt;/version&gt;</span>
314
315<span style='color:Green;'>&lt;headers&gt;</span>
316 /usr/local/Qt-5.5.0/include/QtCore
317<span style='color:Green;'>&lt;/headers&gt;</span>
318
319<span style='color:Green;'>&lt;libs&gt;</span>
320 /usr/local/Qt-5.5.0/lib/libQt5Core.so.5.5.0
321<span style='color:Green;'>&lt;/libs&gt;</span>
322
323<span style='color:Green;'>&lt;include_paths&gt;</span>
324 /usr/local/Qt-5.5.0/include/
325<span style='color:Green;'>&lt;/include_paths&gt;</span>
326
327<span style='color:Green;'>&lt;skip_headers&gt;</span>
328 /private/
329 qt_windows.h
330 qatomic_*
331 *_impl.h
332<span style='color:Green;'>&lt;/skip_headers&gt;</span>
333
334<span style='color:Green;'>&lt;gcc_options&gt;</span>
335 -fvisibility=hidden
336 -fvisibility-inlines-hidden
337 -fPIC
338 -Wall
339 -W
340 -D_REENTRANT
341 -DQT_NO_CAST_FROM_ASCII
342 -DQT_NO_CAST_TO_ASCII
343 -DQT_NO_STL
344 -DQT_SHARED
345<span style='color:Green;'>&lt;/gcc_options&gt;</span>
346</pre>
347</div>
348<p/>
349
350libxslt:
351<div class='listing'>
352<pre>
353<span style='color:Green;'>&lt;version&gt;</span>
354 1.1.22
355<span style='color:Green;'>&lt;/version&gt;</span>
356
357<span style='color:Green;'>&lt;headers&gt;</span>
358 /usr/local/libxslt-1.1.22/include/
359<span style='color:Green;'>&lt;/headers&gt;</span>
360
361<span style='color:Green;'>&lt;libs&gt;</span>
362 /usr/local/libxslt-1.1.22/lib/libxslt.so
363 /usr/local/libxslt-1.1.22/lib/libexslt.so
364<span style='color:Green;'>&lt;/libs&gt;</span>
365
366<span style='color:Green;'>&lt;include_paths&gt;</span>
367 /usr/include/libxml2/
368<span style='color:Green;'>&lt;/include_paths&gt;</span>
369
370<span style='color:Green;'>&lt;include_preamble&gt;</span>
371 xsltInternals.h
372<span style='color:Green;'>&lt;/include_preamble&gt;</span>
373</pre>
374</div>
375<p/>
376
377libxml++:
378<div class='listing'>
379<pre>
380<span style='color:Green;'>&lt;version&gt;</span>
381 2.26.1
382<span style='color:Green;'>&lt;/version&gt;</span>
383
384<span style='color:Green;'>&lt;headers&gt;</span>
385 /usr/local/libxml++-2.26.1/include/
386 /usr/local/libxml++-2.26.1/lib/libxml++-2.6/include/
387<span style='color:Green;'>&lt;/headers&gt;</span>
388
389<span style='color:Green;'>&lt;libs&gt;</span>
390 /usr/local/libxml++-2.26.1/lib/
391<span style='color:Green;'>&lt;/libs&gt;</span>
392
393<span style='color:Green;'>&lt;include_paths&gt;</span>
394 /usr/include/glib-2.0/
395 /usr/lib/glib-2.0/include/
396 /usr/include/glibmm-2.4/
397 /usr/lib/glibmm-2.4/include/
398<span style='color:Green;'>&lt;/include_paths&gt;</span>
399</pre>
400</div>
401<p/>
402
403pango:
404<div class='listing'>
405<pre>
406<span style='color:Green;'>&lt;version&gt;</span>
407 1.26.0
408<span style='color:Green;'>&lt;/version&gt;</span>
409
410<span style='color:Green;'>&lt;headers&gt;</span>
411 /usr/local/pango-1.26.0/include/
412<span style='color:Green;'>&lt;/headers&gt;</span>
413
414<span style='color:Green;'>&lt;libs&gt;</span>
415 /usr/local/pango-1.26.0/lib/
416<span style='color:Green;'>&lt;/libs&gt;</span>
417
418<span style='color:Green;'>&lt;include_paths&gt;</span>
419 /usr/include/glib-2.0/
420 /usr/lib/glib-2.0/include/
421 /usr/include/cairo/
422 /usr/include/freetype2/
423 /usr/include/X11/
424<span style='color:Green;'>&lt;/include_paths&gt;</span>
425
426<span style='color:Green;'>&lt;include_preamble&gt;</span>
427 pango.h
428<span style='color:Green;'>&lt;/include_preamble&gt;</span>
429</pre>
430</div>
431<p/>
432
433gtk+:
434<div class='listing'>
435<pre>
436<span style='color:Green;'>&lt;version&gt;</span>
437 2.18.4
438<span style='color:Green;'>&lt;/version&gt;</span>
439
440<span style='color:Green;'>&lt;headers&gt;</span>
441 /usr/local/gtk+-2.18.4/include/gtk-2.0/gdk/gdk.h
442 /usr/local/gtk+-2.18.4/include/gtk-2.0/gtk/gtk.h
443 /usr/local/gtk+-2.18.4/include/gail-1.0/
444 /usr/local/gtk+-2.18.4/include/gtk-unix-print-2.0/
445<span style='color:Green;'>&lt;/headers&gt;</span>
446
447<span style='color:Green;'>&lt;libs&gt;</span>
448 /usr/local/gtk+-2.18.4/lib/
449<span style='color:Green;'>&lt;/libs&gt;</span>
450
451<span style='color:Green;'>&lt;include_paths&gt;</span>
452 /usr/include/atk-1.0/
453 /usr/include/glib-2.0/
454 /usr/lib/glib-2.0/include/
455 /usr/include/cairo/
456 /usr/include/pango-1.0/
457<span style='color:Green;'>&lt;/include_paths&gt;</span>
458</pre>
459</div>
460<p/>
461
462glib:
463<div class='listing'>
464<pre>
465<span style='color:Green;'>&lt;version&gt;</span>
466 2.22.2
467<span style='color:Green;'>&lt;/version&gt;</span>
468
469<span style='color:Green;'>&lt;headers&gt;</span>
470 /usr/local/glib-2.22.2/include/glib-2.0/glib.h
471 /usr/local/glib-2.22.2/include/glib-2.0/glib-object.h
472 /usr/local/glib-2.22.2/include/glib-2.0/gmodule.h
473<span style='color:Green;'>&lt;/headers&gt;</span>
474
475<span style='color:Green;'>&lt;libs&gt;</span>
476 /usr/local/glib-2.22.2/lib/
477<span style='color:Green;'>&lt;/libs&gt;</span>
478
479<span style='color:Green;'>&lt;include_paths&gt;</span>
480 /usr/local/glib-2.22.2/lib/glib-2.0/include/
481<span style='color:Green;'>&lt;/include_paths&gt;</span>
482</pre>
483</div>
484<p/>
485
486libsoup:
487<div class='listing'>
488<pre>
489<span style='color:Green;'>&lt;version&gt;</span>
490 2.28.0
491<span style='color:Green;'>&lt;/version&gt;</span>
492
493<span style='color:Green;'>&lt;headers&gt;</span>
494 /usr/local/libsoup-2.28.0/include/
495<span style='color:Green;'>&lt;/headers&gt;</span>
496
497<span style='color:Green;'>&lt;libs&gt;</span>
498 /usr/local/libsoup-2.28.0/lib/
499<span style='color:Green;'>&lt;/libs&gt;</span>
500
501<span style='color:Green;'>&lt;include_paths&gt;</span>
502 /usr/include/glib-2.0/
503 /usr/lib/glib-2.0/include/
504<span style='color:Green;'>&lt;/include_paths&gt;</span>
505</pre>
506</div>
507<p/>
508
509allegro:
510<div class='listing'>
511<pre>
512<span style='color:Green;'>&lt;version&gt;</span>
513 4.9.9.1
514<span style='color:Green;'>&lt;/version&gt;</span>
515
516<span style='color:Green;'>&lt;headers&gt;</span>
517 /usr/local/include/allegro5/allegro.h
518<span style='color:Green;'>&lt;/headers&gt;</span>
519
520<span style='color:Green;'>&lt;libs&gt;</span>
521 /usr/local/lib/liballegro-4.9.9.so
522<span style='color:Green;'>&lt;/libs&gt;</span>
523</pre>
524</div>
525<p/>
526
527mathgl:
528<div class='listing'>
529<pre>
530<span style='color:Green;'>&lt;version&gt;</span>
531 1.9.0.1
532<span style='color:Green;'>&lt;/version&gt;</span>
533
534<span style='color:Green;'>&lt;headers&gt;</span>
535 /usr/local/mathgl-1.9.0.1/include/
536<span style='color:Green;'>&lt;/headers&gt;</span>
537
538<span style='color:Green;'>&lt;libs&gt;</span>
539 /usr/local/mathgl-1.9.0.1/lib/
540<span style='color:Green;'>&lt;/libs&gt;</span>
541
542<span style='color:Green;'>&lt;include_paths&gt;</span>
543 /usr/local/gsl-1.9/include/
544<span style='color:Green;'>&lt;/include_paths&gt;</span>
545</pre>
546</div>
547<p/>
548
549gsl:
550<div class='listing'>
551<pre>
552<span style='color:Green;'>&lt;version&gt;</span>
553 1.9
554<span style='color:Green;'>&lt;/version&gt;</span>
555
556<span style='color:Green;'>&lt;headers&gt;</span>
557 /usr/local/gsl-1.9/include/
558<span style='color:Green;'>&lt;/headers&gt;</span>
559
560<span style='color:Green;'>&lt;libs&gt;</span>
561 /usr/local/gsl-1.9/lib/
562<span style='color:Green;'>&lt;/libs&gt;</span>
563
564<span style='color:Green;'>&lt;include_preamble&gt;</span>
565 stdlib.h
566<span style='color:Green;'>&lt;/include_preamble&gt;</span>
567</pre>
568</div>
569<p/>
570
571libjpeg:
572<div class='listing'>
573<pre>
574<span style='color:Green;'>&lt;version&gt;</span>
575 7
576<span style='color:Green;'>&lt;/version&gt;</span>
577
578<span style='color:Green;'>&lt;headers&gt;</span>
579 /usr/local/libjpeg-7/include/jpeglib.h
580<span style='color:Green;'>&lt;/headers&gt;</span>
581
582<span style='color:Green;'>&lt;libs&gt;</span>
583 /usr/local/libjpeg-7/lib/
584<span style='color:Green;'>&lt;/libs&gt;</span>
585
586<span style='color:Green;'>&lt;include_preamble&gt;</span>
587 stdio.h
588<span style='color:Green;'>&lt;/include_preamble&gt;</span>
589</pre>
590</div>
591<p/>
592
593<div class="footer">
594 get the source code on GitHub : <a href="https://github.com/lvc/abi-compliance-checker">lvc/abi-compliance-checker</a>
595</div>
596
597<br/>
598<br/>
599
600</div>
601</body>
602</html>