Skip to content

Commit e771d41

Browse files
mmathesiussgallagher
authored andcommitted
Make PackagerV3 and BuildConfig objects public
Signed-off-by: Merlin Mathesius <[email protected]>
1 parent 5d8df20 commit e771d41

14 files changed

+301
-238
lines changed

modulemd/include/private/modulemd-build-config.h renamed to modulemd/include/modulemd-2.0/modulemd-build-config.h

Lines changed: 26 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@
1313

1414
#pragma once
1515

16+
#include "modulemd-buildopts.h"
1617
#include <glib-object.h>
17-
#include "modulemd-2.0/modulemd-buildopts.h"
18-
#include "private/modulemd-yaml.h"
1918

2019
G_BEGIN_DECLS
2120

2221
/**
2322
* SECTION: modulemd-build-config
2423
* @title: Modulemd.BuildConfig
25-
* @stability: private
26-
* @short_description: Internal representation of a module build configuration
24+
* @stability: stable
25+
* @short_description: The data to represent a configuration for building a
26+
* module stream.
2727
*/
2828

2929
#define MODULEMD_TYPE_BUILD_CONFIG (modulemd_build_config_get_type ())
@@ -38,7 +38,7 @@ G_DECLARE_FINAL_TYPE (
3838
* Initialize a new #ModulemdBuildConfig representing a module build
3939
* configuration.
4040
*
41-
* Since: 2.10
41+
* Since: 2.11
4242
*/
4343
ModulemdBuildConfig *
4444
modulemd_build_config_new (void);
@@ -55,7 +55,7 @@ modulemd_build_config_new (void);
5555
* @context. This validation will be performed as part of the
5656
* modulemd_build_config_validate() routine where it can be reported cleanly.
5757
*
58-
* Since: 2.10
58+
* Since: 2.11
5959
*/
6060
void
6161
modulemd_build_config_set_context (ModulemdBuildConfig *self,
@@ -75,7 +75,7 @@ modulemd_build_config_set_context (ModulemdBuildConfig *self,
7575
* Returns: (transfer none): The string representing the context that this
7676
* build configuration produces.
7777
*
78-
* Since: 2.10
78+
* Since: 2.11
7979
*/
8080
const gchar *
8181
modulemd_build_config_get_context (ModulemdBuildConfig *self);
@@ -88,7 +88,7 @@ modulemd_build_config_get_context (ModulemdBuildConfig *self);
8888
*
8989
* Set the platform that this build configuration applies to.
9090
*
91-
* Since: 2.10
91+
* Since: 2.11
9292
*/
9393
void
9494
modulemd_build_config_set_platform (ModulemdBuildConfig *self,
@@ -104,7 +104,7 @@ modulemd_build_config_set_platform (ModulemdBuildConfig *self,
104104
* Returns: (transfer none): The string representing the platform that this
105105
* build configuration applies to.
106106
*
107-
* Since: 2.10
107+
* Since: 2.11
108108
*/
109109
const gchar *
110110
modulemd_build_config_get_platform (ModulemdBuildConfig *self);
@@ -118,7 +118,7 @@ modulemd_build_config_get_platform (ModulemdBuildConfig *self);
118118
*
119119
* Add a build-time dependency for this module.
120120
*
121-
* Since: 2.10
121+
* Since: 2.11
122122
*/
123123
void
124124
modulemd_build_config_add_runtime_requirement (ModulemdBuildConfig *self,
@@ -133,7 +133,7 @@ modulemd_build_config_add_runtime_requirement (ModulemdBuildConfig *self,
133133
*
134134
* Remove a run-time dependency for this module.
135135
*
136-
* Since: 2.10
136+
* Since: 2.11
137137
*/
138138
void
139139
modulemd_build_config_remove_runtime_requirement (ModulemdBuildConfig *self,
@@ -146,7 +146,7 @@ modulemd_build_config_remove_runtime_requirement (ModulemdBuildConfig *self,
146146
*
147147
* Remove all run-time dependencies for this module.
148148
*
149-
* Since: 2.10
149+
* Since: 2.11
150150
*/
151151
void
152152
modulemd_build_config_clear_runtime_requirements (ModulemdBuildConfig *self);
@@ -160,7 +160,7 @@ modulemd_build_config_clear_runtime_requirements (ModulemdBuildConfig *self);
160160
* Returns: (transfer none): The name of the stream matching this module name
161161
* in the run-time dependencies.
162162
*
163-
* Since: 2.10
163+
* Since: 2.11
164164
*/
165165
const gchar *
166166
modulemd_build_config_get_runtime_requirement_stream (
@@ -174,7 +174,7 @@ modulemd_build_config_get_runtime_requirement_stream (
174174
* Returns: (transfer full): An ordered #GStrv list of module names that this
175175
* module depends on at run-time.
176176
*
177-
* Since: 2.10
177+
* Since: 2.11
178178
*/
179179
GStrv
180180
modulemd_build_config_get_runtime_modules_as_strv (ModulemdBuildConfig *self);
@@ -188,7 +188,7 @@ modulemd_build_config_get_runtime_modules_as_strv (ModulemdBuildConfig *self);
188188
*
189189
* Add a build-time dependency for this module.
190190
*
191-
* Since: 2.10
191+
* Since: 2.11
192192
*/
193193
void
194194
modulemd_build_config_add_buildtime_requirement (ModulemdBuildConfig *self,
@@ -203,7 +203,7 @@ modulemd_build_config_add_buildtime_requirement (ModulemdBuildConfig *self,
203203
*
204204
* Remove a build-time dependency for this module.
205205
*
206-
* Since: 2.10
206+
* Since: 2.11
207207
*/
208208
void
209209
modulemd_build_config_remove_buildtime_requirement (ModulemdBuildConfig *self,
@@ -216,7 +216,7 @@ modulemd_build_config_remove_buildtime_requirement (ModulemdBuildConfig *self,
216216
*
217217
* Remove all build-time dependencies for this module.
218218
*
219-
* Since: 2.10
219+
* Since: 2.11
220220
*/
221221
void
222222
modulemd_build_config_clear_buildtime_requirements (ModulemdBuildConfig *self);
@@ -230,7 +230,7 @@ modulemd_build_config_clear_buildtime_requirements (ModulemdBuildConfig *self);
230230
* Returns: (transfer none): The name of the stream matching this module name
231231
* in the build-time dependencies.
232232
*
233-
* Since: 2.10
233+
* Since: 2.11
234234
*/
235235
const gchar *
236236
modulemd_build_config_get_buildtime_requirement_stream (
@@ -244,7 +244,7 @@ modulemd_build_config_get_buildtime_requirement_stream (
244244
* Returns: (transfer full): An ordered #GStrv list of module names that this
245245
* module depends on at build-time.
246246
*
247-
* Since: 2.10
247+
* Since: 2.11
248248
*/
249249
GStrv
250250
modulemd_build_config_get_buildtime_modules_as_strv (
@@ -259,7 +259,7 @@ modulemd_build_config_get_buildtime_modules_as_strv (
259259
*
260260
* Set build options for this module's components.
261261
*
262-
* Since: 2.10
262+
* Since: 2.11
263263
*/
264264
void
265265
modulemd_build_config_set_buildopts (ModulemdBuildConfig *self,
@@ -272,51 +272,12 @@ modulemd_build_config_set_buildopts (ModulemdBuildConfig *self,
272272
*
273273
* Returns: (transfer none): The build options for this module's components.
274274
*
275-
* Since: 2.10
275+
* Since: 2.11
276276
*/
277277
ModulemdBuildopts *
278278
modulemd_build_config_get_buildopts (ModulemdBuildConfig *self);
279279

280280

281-
/**
282-
* modulemd_build_config_parse_yaml:
283-
* @parser: A #yaml_parser_t positioned at the start of a configuration
284-
* entry of a ModulemdPackager v3 YAML document.
285-
* @strict: Whether to ignore unknown keys in the YAML
286-
* @error: (out): A #GError explaining any failure to complete the parsing
287-
*
288-
* Returns: (transfer full): A newly-constructed #ModulemdBuildConfig object
289-
* populated from the data in the provided YAML. Returns NULL and sets @error
290-
* appropriately if the document couldn't be parsed successfully or failed
291-
* validation.
292-
*
293-
* Since: 2.10
294-
*/
295-
ModulemdBuildConfig *
296-
modulemd_build_config_parse_yaml (yaml_parser_t *parser,
297-
gboolean strict,
298-
GError **error);
299-
300-
301-
/**
302-
* modulemd_build_config_emit_yaml:
303-
* @self: This #ModulemdBuildConfig object.
304-
* @emitter: (inout): A libyaml emitter object positioned where a BuidConfig
305-
* belongs in the YAML document.
306-
* @error: (out): A #GError that will return the reason for an emission or
307-
* validation error.
308-
*
309-
* Returns: TRUE if the BuildConfig was emitted successfully. FALSE and sets
310-
* @error appropriately if the YAML could not be emitted.
311-
*
312-
* Since: 2.10
313-
*/
314-
gboolean
315-
modulemd_build_config_emit_yaml (ModulemdBuildConfig *self,
316-
yaml_emitter_t *emitter,
317-
GError **error);
318-
319-
320281
/**
321282
* modulemd_build_config_validate:
322283
* @self: (in): This #ModulemdBuildConfig object.
@@ -328,12 +289,11 @@ modulemd_build_config_emit_yaml (ModulemdBuildConfig *self,
328289
* Returns: TRUE if validation passes. Returns FALSE and sets @error
329290
* appropriately on validation failure.
330291
*
331-
* Since: 2.10
292+
* Since: 2.11
332293
*/
333294

334295
gboolean
335-
modulemd_build_config_validate (ModulemdBuildConfig *buildconfig,
336-
GError **error);
296+
modulemd_build_config_validate (ModulemdBuildConfig *self, GError **error);
337297

338298

339299
/**
@@ -342,7 +302,7 @@ modulemd_build_config_validate (ModulemdBuildConfig *buildconfig,
342302
*
343303
* Returns: (transfer full): A deep copy of @self
344304
*
345-
* Since: 2.10
305+
* Since: 2.11
346306
*/
347307
ModulemdBuildConfig *
348308
modulemd_build_config_copy (ModulemdBuildConfig *self);
@@ -356,7 +316,7 @@ modulemd_build_config_copy (ModulemdBuildConfig *self);
356316
* Returns: TRUE, if @self_1 and @self_2 are pointers to #ModulemdBuildConfig
357317
* objects containing equivalent data. FALSE, otherwise.
358318
*
359-
* Since: 2.10
319+
* Since: 2.11
360320
*/
361321

362322
gboolean
@@ -372,7 +332,7 @@ modulemd_build_config_equals (ModulemdBuildConfig *self_1,
372332
* Returns: Less than zero if @self_1 sorts less than @self_2, zero for equal,
373333
* greater than zero if @self_1 is greater than @self_2.
374334
*
375-
* Since: 2.10
335+
* Since: 2.11
376336
*/
377337
gint
378338
modulemd_build_config_compare (ModulemdBuildConfig *self_1,

0 commit comments

Comments
 (0)