blob: e365b57f3bbdd6267184dd697ba008ace56ed437 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en" dir="ltr" class="client-nojs">
<head>
<title>Library Descriptor</title>
<meta charset="UTF-8" />
<meta name="generator" content="MediaWiki 1.18.1" />
<link rel="shortcut icon" href="/favicon.ico" />
<link rel="search" type="application/opensearchdescription+xml" href="/opensearch_desc.php" title="ISP_RAS (en)" />
<link rel="EditURI" type="application/rsd+xml" href="http://ispras.linuxbase.org/api.php?action=rsd" />
<link rel="alternate" type="application/atom+xml" title="ISP_RAS Atom feed" href="/index.php?title=Special:RecentChanges&amp;feed=atom" />
<link rel="stylesheet" href="/load.php?debug=false&amp;lang=en&amp;modules=mediawiki.legacy.commonPrint%2Cshared%7Cskins.monobook&amp;only=styles&amp;skin=monobook&amp;*" />
<!--[if lt IE 5.5000]><link rel="stylesheet" href="/skins/monobook/IE50Fixes.css?303" media="screen" /><![endif]-->
<!--[if IE 5.5000]><link rel="stylesheet" href="/skins/monobook/IE55Fixes.css?303" media="screen" /><![endif]-->
<!--[if IE 6]><link rel="stylesheet" href="/skins/monobook/IE60Fixes.css?303" media="screen" /><![endif]-->
<!--[if IE 7]><link rel="stylesheet" href="/skins/monobook/IE70Fixes.css?303" media="screen" /><![endif]--><meta name="ResourceLoaderDynamicStyles" content="" />
<link rel="stylesheet" href="/load.php?debug=false&amp;lang=en&amp;modules=site&amp;only=styles&amp;skin=monobook&amp;*" />
<style>a:lang(ar),a:lang(ckb),a:lang(fa),a:lang(kk-arab),a:lang(mzn),a:lang(ps),a:lang(ur){text-decoration:none}a.new,#quickbar a.new{color:#ba0000}
/* cache key: rasispdb:resourceloader:filter:minify-css:4:c88e2bcd56513749bec09a7e29cb3ffa */
</style>
<script src="/load.php?debug=false&amp;lang=en&amp;modules=startup&amp;only=scripts&amp;skin=monobook&amp;*"></script>
<script>if(window.mw){
mw.config.set({"wgCanonicalNamespace": "", "wgCanonicalSpecialPageName": false, "wgNamespaceNumber": 0, "wgPageName": "Library_Descriptor", "wgTitle": "Library Descriptor", "wgCurRevisionId": 8241, "wgArticleId": 2415, "wgIsArticle": true, "wgAction": "view", "wgUserName": null, "wgUserGroups": ["*"], "wgCategories": ["API Sanity Checker", "ABI Compliance Checker"], "wgBreakFrames": false, "wgRestrictionEdit": [], "wgRestrictionMove": []});
}
</script><script>if(window.mw){
mw.loader.load(["mediawiki.page.startup"]);
}
</script>
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-Library_Descriptor action-view skin-monobook">
<div id="globalWrapper">
<div id="column-content"><div id="content">
<a id="top"></a>
<h1 id="firstHeading" class="firstHeading">Library Descriptor</h1>
<div id="bodyContent">
<div id="siteSub"></div>
<div id="contentSub"></div>
<!-- start content -->
<div lang="en" dir="ltr" class="mw-content-ltr"><p><i>Library descriptor</i> is a simple XML-file that specifies version number, paths to header files and shared libraries and optionally some other information.
</p>
<table id="toc" class="toc"><tr><td><div id="toctitle"><h2>Contents</h2></div>
<ul>
<li class="toclevel-1 tocsection-1"><a href="#Primary_Sections"><span class="tocnumber">1</span> <span class="toctext">Primary Sections</span></a></li>
<li class="toclevel-1 tocsection-2"><a href="#Optional_Sections"><span class="tocnumber">2</span> <span class="toctext">Optional Sections</span></a></li>
<li class="toclevel-1 tocsection-3"><a href="#Extra_Sections_.28API_Sanity_Checker.29"><span class="tocnumber">3</span> <span class="toctext">Extra Sections (API Sanity Checker)</span></a></li>
<li class="toclevel-1 tocsection-4"><a href="#Examples"><span class="tocnumber">4</span> <span class="toctext">Examples</span></a></li>
</ul>
</td></tr></table>
<h2> <span class="mw-headline" id="Primary_Sections"> Primary Sections </span></h2>
<pre> <span style="color:Green;">&lt;version&gt;</span>
/* Version of the library */
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/* The list of paths to header files or/and
directories with header files, one per line */
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/* The list of paths to shared libraries or/and
directories with shared libraries, one per line */
<span style="color:Green;">&lt;/libs&gt;</span>
</pre>
<h2> <span class="mw-headline" id="Optional_Sections"> Optional Sections </span></h2>
<pre> <span style="color:Green;">&lt;include_paths&gt;</span>
/* The list of paths to be searched for header files
needed for compiling of library headers, one per line.
NOTE: If you define this section then the tool
will not automatically detect include paths */
<span style="color:Green;">&lt;/include_paths&gt;</span>
<span style="color:Green;">&lt;add_include_paths&gt;</span>
/* The list of include paths that should be added
to the automatically detected include paths, one per line */
<span style="color:Green;">&lt;/add_include_paths&gt;</span>
<span style="color:Green;">&lt;skip_include_paths&gt;</span>
/* The list of include paths that will be removed from the
list of automatically generated include paths, one per line */
<span style="color:Green;">&lt;/skip_include_paths&gt;</span>
<span style="color:Green;">&lt;gcc_options&gt;</span>
/* Additional GCC options, one per line */
<span style="color:Green;">&lt;/gcc_options&gt;</span>
<span style="color:Green;">&lt;include_preamble&gt;</span>
/* The list of header files that should be included before other headers, one per line.
For example, it is a tree.h for libxml2 and ft2build.h for freetype2 library */
<span style="color:Green;">&lt;/include_preamble&gt;</span>
<span style="color:Green;">&lt;defines&gt;</span>
/* Add defines at the headers compiling stage, one per line:
#define A B
#define C D */
<span style="color:Green;">&lt;/defines&gt;</span>
<span style="color:Green;">&lt;add_namespaces&gt;</span>
/* The list of namespaces that should be added to the alanysis
if the tool cannot find them automatically, one per line */
<span style="color:Green;">&lt;/add_namespaces&gt;</span>
<span style="color:Green;">&lt;skip_types&gt;</span>
/* The list of data types, that
should not be checked, one per line */
<span style="color:Green;">&lt;/skip_types&gt;</span>
<span style="color:Green;">&lt;skip_symbols&gt;</span>
/* The list of functions (mangled/symbol names in C++),
that should not be checked, one per line */
<span style="color:Green;">&lt;/skip_symbols&gt;</span>
<span style="color:Green;">&lt;skip_namespaces&gt;</span>
/* The list of C++ namespaces, that
should not be checked, one per line */
<span style="color:Green;">&lt;/skip_namespaces&gt;</span>
<span style="color:Green;">&lt;skip_constants&gt;</span>
/* The list of constants that should not be checked, one name per line */
<span style="color:Green;">&lt;/skip_constants&gt;</span>
<span style="color:Green;">&lt;skip_headers&gt;</span>
/* The list of header files and/or directories
with header files that should not be checked, one per line */
<span style="color:Green;">&lt;/skip_headers&gt;</span>
<span style="color:Green;">&lt;skip_libs&gt;</span>
/* The list of shared libraries and/or directories
with shared libraries that should not be checked, one per line */
<span style="color:Green;">&lt;/skip_libs&gt;</span>
<span style="color:Green;">&lt;skip_including&gt;</span>
/* The list of header files, that cannot be included
directly (or non-self compiled ones), one per line */
<span style="color:Green;">&lt;/skip_including&gt;</span>
<span style="color:Green;">&lt;search_headers&gt;</span>
/* List of directories to be searched
for header files to automatically
generate include paths, one per line */
<span style="color:Green;">&lt;/search_headers&gt;</span>
<span style="color:Green;">&lt;search_libs&gt;</span>
/* List of directories to be searched
for shared librariess to resolve
dependencies, one per line */
<span style="color:Green;">&lt;/search_libs&gt;</span>
<span style="color:Green;">&lt;tools&gt;</span>
/* List of directories with tools used
for analysis (GCC toolchain), one per line */
<span style="color:Green;">&lt;/tools&gt;</span>
<span style="color:Green;">&lt;cross_prefix&gt;</span>
/* GCC toolchain prefix.
Examples:
arm-linux-gnueabi
arm-none-symbianelf */
<span style="color:Green;">&lt;/cross_prefix&gt;</span>
</pre>
<h2> <span class="mw-headline" id="Extra_Sections_.28API_Sanity_Checker.29"> Extra Sections (API Sanity Checker) </span></h2>
<pre> <span style="color:Green;">&lt;test_include_preamble&gt;</span>
/* The list of header files that should be
included in each test case before other
headers, one per line */
<span style="color:Green;">&lt;/test_include_preamble&gt;</span>
<span style="color:Green;">&lt;test_defines&gt;</span>
/* Add defines to test cases */
<span style="color:Green;">&lt;/test_defines&gt;</span>
</pre>
<h2> <span class="mw-headline" id="Examples"> Examples </span></h2>
<ul><li> <b>libssh</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
0.3.4
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/libssh/0.3.4/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/libssh/0.3.4/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
</pre>
<ul><li> <b>ATK</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
1.28.0
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/atk-1.28.0/include/atk-1.0/atk/atk.h
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/atk-1.28.0/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/include/glib-2.0/
/usr/lib/glib-2.0/include/
<span style="color:Green;">&lt;/include_paths&gt;</span>
</pre>
<ul><li> <b>libxml2</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
2.7.6
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/libxml2-2.7.6/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/libxml2-2.7.6/lib/libxml2.so.2.7.6
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_preamble&gt;</span>
tree.h
<span style="color:Green;">&lt;/include_preamble&gt;</span>
</pre>
<ul><li> <b>libX11</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
1.3.2
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/libX11-1.3.2/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/libX11-1.3.2/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_preamble&gt;</span>
Xlib.h
<span style="color:Green;">&lt;/include_preamble&gt;</span>
</pre>
<ul><li> <b>BlackBerry 10 Native SDK</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
10
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/home/RIM/bbndk/target_10_0_9_1673/qnx6/usr/include/bb/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;search_headers&gt;</span>
/home/RIM/bbndk/target_10_0_9_1673/qnx6/usr/include/
<span style="color:Green;">&lt;/search_headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/home/RIM/bbndk/target_10_0_9_1673/qnx6/x86/usr/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;tools&gt;</span>
/home/RIM/bbndk/host_10_0_9_404/linux/x86/usr/bin/
<span style="color:Green;">&lt;/tools&gt;</span>
<span style="color:Green;">&lt;cross_prefix&gt;</span>
i486-pc-nto-qnx8.0.0
<span style="color:Green;">&lt;/cross_prefix&gt;</span>
</pre>
<ul><li> <b>libQtCore</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
4.6.0
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/Qt-4.6.0/include/QtCore/QtCore
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/Qt-4.6.0/lib/libQtCore.so.4
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/local/Qt-4.6.0/include/
<span style="color:Green;">&lt;/include_paths&gt;</span>
<span style="color:Green;">&lt;gcc_options&gt;</span>
-fvisibility=hidden
-fvisibility-inlines-hidden
-fPIC
-Wall
-W
-D_REENTRANT
-DQT_NO_CAST_FROM_ASCII
-DQT_NO_CAST_TO_ASCII
-DQT_NO_STL
-DQT_SHARED
-DQT3_SUPPORT
<span style="color:Green;">&lt;/gcc_options&gt;</span>
</pre>
<ul><li> <b>libxslt</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
1.1.22
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/libxslt-1.1.22/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/libxslt-1.1.22/lib/libxslt.so
/usr/local/libxslt-1.1.22/lib/libexslt.so
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/include/libxml2/
<span style="color:Green;">&lt;/include_paths&gt;</span>
<span style="color:Green;">&lt;include_preamble&gt;</span>
xsltInternals.h
<span style="color:Green;">&lt;/include_preamble&gt;</span>
</pre>
<ul><li> <b>libxml++</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
2.26.1
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/libxml++-2.26.1/include/
/usr/local/libxml++-2.26.1/lib/libxml++-2.6/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/libxml++-2.26.1/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/include/glib-2.0/
/usr/lib/glib-2.0/include/
/usr/include/glibmm-2.4/
/usr/lib/glibmm-2.4/include/
<span style="color:Green;">&lt;/include_paths&gt;</span>
</pre>
<ul><li> <b>pango</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
1.26.0
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/pango-1.26.0/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/pango-1.26.0/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/include/glib-2.0/
/usr/lib/glib-2.0/include/
/usr/include/cairo/
/usr/include/freetype2/
/usr/include/X11/
<span style="color:Green;">&lt;/include_paths&gt;</span>
<span style="color:Green;">&lt;include_preamble&gt;</span>
pango.h
<span style="color:Green;">&lt;/include_preamble&gt;</span>
</pre>
<ul><li> <b>gtk+</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
2.18.4
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/gtk+-2.18.4/include/gtk-2.0/gdk/gdk.h
/usr/local/gtk+-2.18.4/include/gtk-2.0/gtk/gtk.h
/usr/local/gtk+-2.18.4/include/gail-1.0/
/usr/local/gtk+-2.18.4/include/gtk-unix-print-2.0/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/gtk+-2.18.4/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/include/atk-1.0/
/usr/include/glib-2.0/
/usr/lib/glib-2.0/include/
/usr/include/cairo/
/usr/include/pango-1.0/
<span style="color:Green;">&lt;/include_paths&gt;</span>
</pre>
<ul><li> <b>glib</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
2.22.2
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/glib-2.22.2/include/glib-2.0/glib.h
/usr/local/glib-2.22.2/include/glib-2.0/glib-object.h
/usr/local/glib-2.22.2/include/glib-2.0/gmodule.h
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/glib-2.22.2/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/local/glib-2.22.2/lib/glib-2.0/include/
<span style="color:Green;">&lt;/include_paths&gt;</span>
</pre>
<ul><li> <b>libsoup</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
2.28.0
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/libsoup-2.28.0/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/libsoup-2.28.0/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/include/glib-2.0/
/usr/lib/glib-2.0/include/
<span style="color:Green;">&lt;/include_paths&gt;</span>
</pre>
<ul><li> <b>allegro</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
4.9.9.1
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/include/allegro5/allegro.h
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/lib/liballegro-4.9.9.so
<span style="color:Green;">&lt;/libs&gt;</span>
</pre>
<ul><li> <b>mathgl</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
1.9.0.1
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/mathgl-1.9.0.1/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/mathgl-1.9.0.1/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_paths&gt;</span>
/usr/local/gsl-1.9/include/
<span style="color:Green;">&lt;/include_paths&gt;</span>
</pre>
<ul><li> <b>gsl</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
1.9
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/gsl-1.9/include/
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/gsl-1.9/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_preamble&gt;</span>
stdlib.h
<span style="color:Green;">&lt;/include_preamble&gt;</span>
</pre>
<ul><li> <b>libjpeg</b>
</li></ul>
<pre> <span style="color:Green;">&lt;version&gt;</span>
7
<span style="color:Green;">&lt;/version&gt;</span>
<span style="color:Green;">&lt;headers&gt;</span>
/usr/local/libjpeg-7/include/jpeglib.h
<span style="color:Green;">&lt;/headers&gt;</span>
<span style="color:Green;">&lt;libs&gt;</span>
/usr/local/libjpeg-7/lib/
<span style="color:Green;">&lt;/libs&gt;</span>
<span style="color:Green;">&lt;include_preamble&gt;</span>
stdio.h
<span style="color:Green;">&lt;/include_preamble&gt;</span>
</pre>
<!--
NewPP limit report
Preprocessor node count: 195/1000000
Post-expand include size: 0/2097152 bytes
Template argument size: 0/2097152 bytes
Expensive parser function count: 0/100
-->
<!-- Saved in parser cache with key rasispdb:pcache:idhash:2415-0!*!*!!en!*!* and timestamp 20130916085931 -->
</div></div></div></div></div></body></html>