ostree/apidoc/html/ostree-ostree-version.html

163 lines
6.9 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ostree-version: OSTree API references</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="OSTree API references">
<link rel="up" href="reference.html" title="API Reference">
<link rel="prev" href="ostree-ostree-repo-remote-finder.html" title="ostree-repo-remote-finder">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#ostree-ostree-version.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ostree-ostree-repo-remote-finder.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
</tr></table>
<div class="refentry">
<a name="ostree-ostree-version"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ostree-ostree-version.top_of_page"></a>ostree-version</span></h2>
<p>ostree-version — ostree version checking</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ostree-ostree-version.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="ostree-ostree-version.html#OSTREE-CHECK-VERSION:CAPS" title="OSTREE_CHECK_VERSION()">OSTREE_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ostree-ostree-version.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ostree-ostree-version.html#OSTREE-YEAR-VERSION:CAPS" title="OSTREE_YEAR_VERSION">OSTREE_YEAR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ostree-ostree-version.html#OSTREE-RELEASE-VERSION:CAPS" title="OSTREE_RELEASE_VERSION">OSTREE_RELEASE_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ostree-ostree-version.html#OSTREE-VERSION:CAPS" title="OSTREE_VERSION">OSTREE_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ostree-ostree-version.html#OSTREE-VERSION-S:CAPS" title="OSTREE_VERSION_S">OSTREE_VERSION_S</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ostree-ostree-version.html#OSTREE-VERSION-HEX:CAPS" title="OSTREE_VERSION_HEX">OSTREE_VERSION_HEX</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ostree-ostree-version.description"></a><h2>Description</h2>
<p>ostree provides macros to check the version of the library
at compile-time</p>
</div>
<div class="refsect1">
<a name="ostree-ostree-version.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="OSTREE-CHECK-VERSION:CAPS"></a><h3>OSTREE_CHECK_VERSION()</h3>
<pre class="programlisting">#define OSTREE_CHECK_VERSION(year,release)</pre>
<p>Compile-time version checking. Evaluates to <code class="literal">TRUE</code> if the version
of ostree is equal or greater than the required one.</p>
<div class="refsect3">
<a name="OSTREE-CHECK-VERSION.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>year</p></td>
<td class="parameter_description"><p>required year version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>release</p></td>
<td class="parameter_description"><p>required release version</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2017.4</p>
</div>
</div>
<div class="refsect1">
<a name="ostree-ostree-version.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="OSTREE-YEAR-VERSION:CAPS"></a><h3>OSTREE_YEAR_VERSION</h3>
<pre class="programlisting">#define OSTREE_YEAR_VERSION (2022)
</pre>
<p>ostree year version component (e.g. 2017 if <a class="link" href="ostree-ostree-version.html#OSTREE-VERSION:CAPS" title="OSTREE_VERSION"><code class="literal">OSTREE_VERSION</code></a> is 2017.2)</p>
<p class="since">Since: 2017.4</p>
</div>
<hr>
<div class="refsect2">
<a name="OSTREE-RELEASE-VERSION:CAPS"></a><h3>OSTREE_RELEASE_VERSION</h3>
<pre class="programlisting">#define OSTREE_RELEASE_VERSION (4)
</pre>
<p>ostree release version component (e.g. 2 if <a class="link" href="ostree-ostree-version.html#OSTREE-VERSION:CAPS" title="OSTREE_VERSION"><code class="literal">OSTREE_VERSION</code></a> is 2017.2)</p>
<p class="since">Since: 2017.4</p>
</div>
<hr>
<div class="refsect2">
<a name="OSTREE-VERSION:CAPS"></a><h3>OSTREE_VERSION</h3>
<pre class="programlisting">#define OSTREE_VERSION (2022.4)
</pre>
<p>ostree version.</p>
<p class="since">Since: 2017.4</p>
</div>
<hr>
<div class="refsect2">
<a name="OSTREE-VERSION-S:CAPS"></a><h3>OSTREE_VERSION_S</h3>
<pre class="programlisting">#define OSTREE_VERSION_S "2022.4"
</pre>
<p>ostree version, encoded as a string, useful for printing and
concatenation.</p>
<p class="since">Since: 2017.4</p>
</div>
<hr>
<div class="refsect2">
<a name="OSTREE-VERSION-HEX:CAPS"></a><h3>OSTREE_VERSION_HEX</h3>
<pre class="programlisting">#define OSTREE_VERSION_HEX</pre>
<p>ostree version, encoded as an hexadecimal number, useful for
integer comparisons.</p>
<p class="since">Since: 2017.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>