Skip to content

Commit 2eddd2d

Browse files
author
Libmodulemd CI
committed
Updating libmodulemd docs for af23bff3fd51319ee26dd4835a98f277eafd60e8
Signed-off-by: Libmodulemd CI <[email protected]>
1 parent 326f478 commit 2eddd2d

File tree

3 files changed

+23
-11
lines changed

3 files changed

+23
-11
lines changed

libmodulemd/latest/modulemd-2.0-Modulemd.DefaultsV1.html

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,10 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.DefaultsV1.top_of
204204
</tr>
205205
<tr>
206206
<td class="parameter_name"><p>intent</p></td>
207-
<td class="parameter_description"><p>If non-NULL, this indicates the system-intent to
208-
apply this default stream. If NULL, it will be added as common defaults. </p></td>
207+
<td class="parameter_description"><p>If non-NULL, this indicates the system intent to
208+
apply this default stream. If NULL, it will be added as common defaults.
209+
System intents are deprecated and calls with this non-NULL argument will
210+
become void in the future. </p></td>
209211
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
210212
</tr>
211213
</tbody>
@@ -238,7 +240,9 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.DefaultsV1.top_of
238240
<td class="parameter_name"><p>intent</p></td>
239241
<td class="parameter_description"><p>The name of the system intent whose default stream
240242
will be retrieved. If left NULL or the specified intent has no different
241-
default, it will return the generic default stream for this module. </p></td>
243+
default, it will return the generic default stream for this module.
244+
System intents are deprecated and this argument will be ignored in the
245+
future. </p></td>
242246
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
243247
</tr>
244248
</tbody>
@@ -278,7 +282,8 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.DefaultsV1.top_of
278282
<td class="parameter_description"><p>The name of the system intent whose stream
279283
profiles will be retrieved. If left NULL or the specified intent has no
280284
separate defaults for this module, it will return the generic stream
281-
profiles. </p></td>
285+
profiles. System intents are deprecated and this argument will be ignored
286+
in the future. </p></td>
282287
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
283288
</tr>
284289
</tbody>
@@ -333,7 +338,8 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.DefaultsV1.top_of
333338
<td class="parameter_name"><p>intent</p></td>
334339
<td class="parameter_description"><p>The name of the system intent to add profile
335340
defaults to. If NULL, this sets the generic fallback profiles for the
336-
stream. </p></td>
341+
stream. System intents are deprecated and calls with this non-NULL argument
342+
will become void in the future. </p></td>
337343
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
338344
</tr>
339345
</tbody>
@@ -375,7 +381,8 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.DefaultsV1.top_of
375381
<tr>
376382
<td class="parameter_name"><p>intent</p></td>
377383
<td class="parameter_description"><p>The name of the system intent from which to clear
378-
the profile defaults for this stream. </p></td>
384+
the profile defaults for this stream. System intents are deprecated and
385+
calls with this non-NULL argument will become void in the future. </p></td>
379386
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
380387
</tr>
381388
</tbody>
@@ -416,7 +423,8 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.DefaultsV1.top_of
416423
<tr>
417424
<td class="parameter_name"><p>intent</p></td>
418425
<td class="parameter_description"><p>The name of the system intent from which to remove
419-
the profile defaults for this stream. </p></td>
426+
the profile defaults for this stream. System intents are deprecated and
427+
calls with this non-NULL arugment will become void in the future. </p></td>
420428
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
421429
</tr>
422430
</tbody>
@@ -455,8 +463,9 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.DefaultsV1.top_of
455463
</tr>
456464
<tr>
457465
<td class="parameter_name"><p>intent</p></td>
458-
<td class="parameter_description"><p>The name of the system intent from which to
459-
retrieve the profile defaults for this stream. </p></td>
466+
<td class="parameter_description"><p>The name of the system intent for which to
467+
retrieve the profile defaults for this stream. System intents are
468+
deprecated and this argument will be ignored in the future. </p></td>
460469
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
461470
</tr>
462471
</tbody>

libmodulemd/latest/modulemd-2.0-Modulemd.ModuleIndex.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1384,7 +1384,9 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
13841384
<td class="parameter_name"><p>intent</p></td>
13851385
<td class="parameter_description"><p>The name of the system intent whose default stream
13861386
will be retrieved. If left NULL or the specified intent has no separate
1387-
default, it will return the generic default stream for this module. </p></td>
1387+
default, it will return the generic default stream for this module.
1388+
System intents are deprecated and this argument will be ignored in the
1389+
future. </p></td>
13881390
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
13891391
</tr>
13901392
</tbody>

libmodulemd/latest/modulemd-2.0-Modulemd.ModuleIndexMerger.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,8 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndexMerger
196196
value is the same, this is an unresolvable merge conflict and the merge
197197
resolution will fail and return an error.</p></li>
198198
<li class="listitem"><p>Intents behave in exactly the same manner as described for the top-level
199-
defaults, except that they merge beneath each intent name.</p></li>
199+
defaults, except that they merge beneath each intent name. Intents are
200+
deprecated.</p></li>
200201
</ul></div>
201202
</li>
202203
</ul></div>

0 commit comments

Comments
 (0)