Skip to content

Commit cb2f74f

Browse files
author
Libmodulemd CI
committed
libmodulemd docs for 2.15.2
Signed-off-by: Libmodulemd CI <[email protected]>
1 parent 664385e commit cb2f74f

File tree

82 files changed

+45031
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+45031
-0
lines changed

libmodulemd/2.15.2/ModulemdComponent.html

Lines changed: 779 additions & 0 deletions
Large diffs are not rendered by default.

libmodulemd/2.15.2/ModulemdDefaults.html

Lines changed: 593 additions & 0 deletions
Large diffs are not rendered by default.

libmodulemd/2.15.2/ModulemdModuleStream.html

Lines changed: 1435 additions & 0 deletions
Large diffs are not rendered by default.

libmodulemd/2.15.2/ch01.html

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>Modulemd 2.0 Public API: Modulemd Reference Manual</title>
6+
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7+
<link rel="home" href="index.html" title="Modulemd Reference Manual">
8+
<link rel="up" href="modulemd-2.0.html" title="libmodulemd">
9+
<link rel="prev" href="modulemd-2.0.html" title="libmodulemd">
10+
<link rel="next" href="modulemd-2.0-Modulemd.html" title="Modulemd">
11+
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
12+
<link rel="stylesheet" href="style.css" type="text/css">
13+
</head>
14+
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15+
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16+
<td width="100%" align="left" class="shortcuts"></td>
17+
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
18+
<td><a accesskey="u" href="modulemd-2.0.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
19+
<td><a accesskey="p" href="modulemd-2.0.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
20+
<td><a accesskey="n" href="modulemd-2.0-Modulemd.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
21+
</tr></table>
22+
<div class="chapter">
23+
<div class="titlepage"><div><div><h2 class="title">
24+
<a name="id-1.2.3"></a>Modulemd 2.0 Public API</h2></div></div></div>
25+
<div class="toc"><dl class="toc">
26+
<dt>
27+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.html">Modulemd</a></span><span class="refpurpose"> — User's Guide for libmodulemd</span>
28+
</dt>
29+
<dt>
30+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.BuildConfig.html">Modulemd.BuildConfig</a></span><span class="refpurpose"> — Internal representation of a module build configuration</span>
31+
</dt>
32+
<dt>
33+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Buildopts.html">Modulemd.Buildopts</a></span><span class="refpurpose"> — Provides hints to the build-system on how to build this module.</span>
34+
</dt>
35+
<dt>
36+
<span class="refentrytitle"><a href="ModulemdComponent.html">Modulemd.Component</a></span><span class="refpurpose"> — Pure virtual parent class for components that go into a module stream.</span>
37+
</dt>
38+
<dt>
39+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ComponentModule.html">Modulemd.ComponentModule</a></span><span class="refpurpose"> — A module component that goes into a module stream.</span>
40+
</dt>
41+
<dt>
42+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ComponentRpm.html">Modulemd.ComponentRpm</a></span><span class="refpurpose"> — An rpm component that goes into a module stream.</span>
43+
</dt>
44+
<dt>
45+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd-Compression-Helpers.html">Modulemd Compression Helpers</a></span><span class="refpurpose"> — Utility functions for working with compressed files.</span>
46+
</dt>
47+
<dt>
48+
<span class="refentrytitle"><a href="ModulemdDefaults.html">Modulemd.Defaults</a></span><span class="refpurpose"> — Parent class for Default documents.
49+
See <span class="type">ModulemdDefaultsV1</span> for a specific type.</span>
50+
</dt>
51+
<dt>
52+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.DefaultsV1.html">Modulemd.DefaultsV1</a></span><span class="refpurpose"> — Object representing a defaults document (version 1)</span>
53+
</dt>
54+
<dt>
55+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Dependencies.html">Modulemd.Dependencies</a></span><span class="refpurpose"> — Object to represent build-time and runtime dependencies of a module stream.</span>
56+
</dt>
57+
<dt>
58+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd-Errors.html">Modulemd Errors</a></span><span class="refpurpose"> — Error codes for libmodulemd.</span>
59+
</dt>
60+
<dt>
61+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Module.html">Modulemd.Module</a></span><span class="refpurpose"> — Collects all information about a module: all of its streams, defaults, etc.</span>
62+
</dt>
63+
<dt>
64+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleIndex.html">Modulemd.ModuleIndex</a></span><span class="refpurpose"> — The primary interface to dealing with repodata in the
65+
module metadata format.</span>
66+
</dt>
67+
<dt>
68+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleIndexMerger.html">Modulemd.ModuleIndexMerger</a></span><span class="refpurpose"> — Class to aid in merging metadata from multiple
69+
repositories.</span>
70+
</dt>
71+
<dt>
72+
<span class="refentrytitle"><a href="ModulemdModuleStream.html">Modulemd.ModuleStream</a></span><span class="refpurpose"> — A parent class for all versions of <span class="type">ModulemdModuleStream</span>
73+
objects.</span>
74+
</dt>
75+
<dt>
76+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleStreamV1.html">Modulemd.ModuleStreamV1</a></span><span class="refpurpose"> — The data to represent a stream of a module as described
77+
by a modulemd YAML document of version 1.</span>
78+
</dt>
79+
<dt>
80+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleStreamV2.html">Modulemd.ModuleStreamV2</a></span><span class="refpurpose"> — The data to represent a stream of a module as described
81+
by a modulemd YAML document of version 2.</span>
82+
</dt>
83+
<dt>
84+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.PackagerV3.html">Modulemd.PackagerV3</a></span><span class="refpurpose"> — Internal representation of the modulemd-packager v3
85+
format.</span>
86+
</dt>
87+
<dt>
88+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Profile.html">Modulemd.Profile</a></span><span class="refpurpose"> — Stores profile information for a module stream.</span>
89+
</dt>
90+
<dt>
91+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.RpmMapEntry.html">Modulemd.RpmMapEntry</a></span><span class="refpurpose"> — Provides an exploded and unexploded view of the NEVRA of
92+
an RPM artifact.</span>
93+
</dt>
94+
<dt>
95+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ServiceLevel.html">Modulemd.ServiceLevel</a></span><span class="refpurpose"> — Provides lifecycle information for a module stream.</span>
96+
</dt>
97+
<dt>
98+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.SubdocumentInfo.html">Modulemd.SubdocumentInfo</a></span><span class="refpurpose"> — Stores information regarding a YAML subdocument in a stream.</span>
99+
</dt>
100+
<dt>
101+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Translation.html">Modulemd.Translation</a></span><span class="refpurpose"> — Translation information for a module stream.</span>
102+
</dt>
103+
<dt>
104+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.TranslationEntry.html">Modulemd.TranslationEntry</a></span><span class="refpurpose"> — Contains the translated strings of a module stream for a specific locale.</span>
105+
</dt>
106+
<dt>
107+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Obsoletes.html">Modulemd.Obsoletes</a></span><span class="refpurpose"> — Obsoletes information for a module stream.</span>
108+
</dt>
109+
</dl></div>
110+
</div>
111+
<div class="footer">
112+
<hr>Generated by GTK-Doc V1.33.1</div>
113+
</body>
114+
</html>

libmodulemd/2.15.2/ch02.html

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>Modulemd 2.0 Private Object Methods: Modulemd Reference Manual</title>
6+
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7+
<link rel="home" href="index.html" title="Modulemd Reference Manual">
8+
<link rel="up" href="modulemd-2.0.html" title="libmodulemd">
9+
<link rel="prev" href="modulemd-2.0-Modulemd.Obsoletes.html" title="Modulemd.Obsoletes">
10+
<link rel="next" href="modulemd-2.0-modulemd-build-config-private.html" title="modulemd-build-config-private">
11+
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
12+
<link rel="stylesheet" href="style.css" type="text/css">
13+
</head>
14+
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15+
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16+
<td width="100%" align="left" class="shortcuts"></td>
17+
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
18+
<td><a accesskey="u" href="modulemd-2.0.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
19+
<td><a accesskey="p" href="modulemd-2.0-Modulemd.Obsoletes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
20+
<td><a accesskey="n" href="modulemd-2.0-modulemd-build-config-private.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
21+
</tr></table>
22+
<div class="chapter">
23+
<div class="titlepage"><div><div><h2 class="title">
24+
<a name="id-1.2.4"></a>Modulemd 2.0 Private Object Methods</h2></div></div></div>
25+
<div class="toc"><dl class="toc">
26+
<dt>
27+
<span class="refentrytitle"><a href="modulemd-2.0-modulemd-build-config-private.html">modulemd-build-config-private</a></span><span class="refpurpose"></span>
28+
</dt>
29+
<dt>
30+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Buildopts-(Private).html">Modulemd.Buildopts (Private)</a></span><span class="refpurpose"><span class="type">ModulemdBuildopts</span> methods that should be used only
31+
by internal consumers.</span>
32+
</dt>
33+
<dt>
34+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Component-(Private).html">Modulemd.Component (Private)</a></span><span class="refpurpose"><span class="type">ModulemdComponent</span> methods that should be used only
35+
by internal consumers.</span>
36+
</dt>
37+
<dt>
38+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ComponentModule-(Private).html">Modulemd.ComponentModule (Private)</a></span><span class="refpurpose"><span class="type">ModulemdComponentModule</span> methods that should be used only
39+
by internal consumers.</span>
40+
</dt>
41+
<dt>
42+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ComponentRpm-(Private).html">Modulemd.ComponentRpm (Private)</a></span><span class="refpurpose"><span class="type">ModulemdComponentRpm</span> methods that should be used only
43+
by internal consumers.</span>
44+
</dt>
45+
<dt>
46+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd-Compression-Helpers-(Private).html">Modulemd Compression Helpers (Private)</a></span><span class="refpurpose"> — Internal utility functions for working with compressed
47+
files.</span>
48+
</dt>
49+
<dt>
50+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Dependencies-(Private).html">Modulemd.Dependencies (Private)</a></span><span class="refpurpose"><span class="type">ModulemdDependencies</span> methods that should be used only
51+
by internal consumers.</span>
52+
</dt>
53+
<dt>
54+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Defaults-(Private).html">Modulemd.Defaults (Private)</a></span><span class="refpurpose"><span class="type">ModulemdDefaults</span> methods that should only be used by
55+
internal consumers.</span>
56+
</dt>
57+
<dt>
58+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.DefaultsV1-(Private).html">Modulemd.DefaultsV1 (Private)</a></span><span class="refpurpose"><span class="type">ModulemdDefaults</span> methods that should only be used by
59+
internal consumers.</span>
60+
</dt>
61+
<dt>
62+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Module-(Private).html">Modulemd.Module (Private)</a></span><span class="refpurpose"><span class="type">ModulemdModule</span> methods that should be used only
63+
by internal consumers.</span>
64+
</dt>
65+
<dt>
66+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleIndex-(Private).html">Modulemd.ModuleIndex (Private)</a></span><span class="refpurpose"><span class="type">ModulemdModuleIndex</span> methods that should be used only
67+
by internal consumers.</span>
68+
</dt>
69+
<dt>
70+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleStream-(Private).html">Modulemd.ModuleStream (Private)</a></span><span class="refpurpose"><span class="type">ModulemdModuleStream</span> methods that should only be used
71+
by internal consumers.</span>
72+
</dt>
73+
<dt>
74+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleStreamV1-(Private).html">Modulemd.ModuleStreamV1 (Private)</a></span><span class="refpurpose"><span class="type">ModulemdModuleStreamV1</span> methods that should only be
75+
used by internal consumers.</span>
76+
</dt>
77+
<dt>
78+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleStreamV2-(Private).html">Modulemd.ModuleStreamV2 (Private)</a></span><span class="refpurpose"><span class="type">ModulemdModuleStreamV2</span> methods that should only be
79+
used by internal consumers.</span>
80+
</dt>
81+
<dt>
82+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.PackagerV3-(Private).html">Modulemd.PackagerV3 (Private)</a></span><span class="refpurpose"><span class="type">ModulemdPackagerV3</span> methods that should only be used by
83+
internal consumers.</span>
84+
</dt>
85+
<dt>
86+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Profile-(Private).html">Modulemd.Profile (Private)</a></span><span class="refpurpose"><span class="type">ModulemdProfile</span> methods that should be used only
87+
by internal consumers.</span>
88+
</dt>
89+
<dt>
90+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.RpmMapEntry-(Private).html">Modulemd.RpmMapEntry (Private)</a></span><span class="refpurpose"><span class="type">ModulemdRpmMapEntry</span> methods that should be used only
91+
by internal consumers.</span>
92+
</dt>
93+
<dt>
94+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ServiceLevel-(Private).html">Modulemd.ServiceLevel (Private)</a></span><span class="refpurpose"><span class="type">ModulemdServiceLevel</span> methods that should be used only
95+
by internal consumers.</span>
96+
</dt>
97+
<dt>
98+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.SubdocumentInfo-(Private).html">Modulemd.SubdocumentInfo (Private)</a></span><span class="refpurpose"><span class="type">ModulemdSubdocumentInfo</span> methods that should be used only
99+
by internal consumers.</span>
100+
</dt>
101+
<dt>
102+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Translation-(Private).html">Modulemd.Translation (Private)</a></span><span class="refpurpose"><span class="type">ModulemdTranslation</span> methods that should be used only
103+
by internal consumers.</span>
104+
</dt>
105+
<dt>
106+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.TranslationEntry-(Private).html">Modulemd.TranslationEntry (Private)</a></span><span class="refpurpose"><span class="type">ModulemdTranslationEntry</span> methods that should be used only
107+
by internal consumers.</span>
108+
</dt>
109+
<dt>
110+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Obsoletes-(Private).html">Modulemd.Obsoletes (Private)</a></span><span class="refpurpose"><span class="type">ModulemdObsoletes</span> methods that should only be used by
111+
internal consumers.</span>
112+
</dt>
113+
</dl></div>
114+
</div>
115+
<div class="footer">
116+
<hr>Generated by GTK-Doc V1.33.1</div>
117+
</body>
118+
</html>

libmodulemd/2.15.2/ch03.html

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>Modulemd 2.0 Private Developer Utilities: Modulemd Reference Manual</title>
6+
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7+
<link rel="home" href="index.html" title="Modulemd Reference Manual">
8+
<link rel="up" href="modulemd-2.0.html" title="libmodulemd">
9+
<link rel="prev" href="modulemd-2.0-Modulemd.Obsoletes-(Private).html" title="Modulemd.Obsoletes (Private)">
10+
<link rel="next" href="modulemd-2.0-Modulemd-Utility-Functions.html" title="Modulemd Utility Functions">
11+
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
12+
<link rel="stylesheet" href="style.css" type="text/css">
13+
</head>
14+
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15+
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16+
<td width="100%" align="left" class="shortcuts"></td>
17+
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
18+
<td><a accesskey="u" href="modulemd-2.0.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
19+
<td><a accesskey="p" href="modulemd-2.0-Modulemd.Obsoletes-(Private).html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
20+
<td><a accesskey="n" href="modulemd-2.0-Modulemd-Utility-Functions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
21+
</tr></table>
22+
<div class="chapter">
23+
<div class="titlepage"><div><div><h2 class="title">
24+
<a name="id-1.2.5"></a>Modulemd 2.0 Private Developer Utilities</h2></div></div></div>
25+
<div class="toc"><dl class="toc">
26+
<dt>
27+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd-Utility-Functions.html">Modulemd Utility Functions</a></span><span class="refpurpose"> — Provides private utility functions for use within
28+
libmodulemd.</span>
29+
</dt>
30+
<dt>
31+
<span class="refentrytitle"><a href="modulemd-2.0-YAML-Manipulation-Tools.html">YAML Manipulation Tools</a></span><span class="refpurpose"> — Provides private YAML utilities for internal use.</span>
32+
</dt>
33+
<dt>
34+
<span class="refentrytitle"><a href="modulemd-2.0-Internal-Unit-Test-Utilities.html">Internal Unit Test Utilities</a></span><span class="refpurpose"> — Utility functions for use with unit tests.</span>
35+
</dt>
36+
</dl></div>
37+
</div>
38+
<div class="footer">
39+
<hr>Generated by GTK-Doc V1.33.1</div>
40+
</body>
41+
</html>

0 commit comments

Comments
 (0)