Modulemd Reference Manual: Modulemd Reference Manual

Modulemd Reference Manual

### Stephen Gallagher

`<sgallagh@redhat.com>`

for Modulemd 2.14.0

Copyright © 2017-2018 Stephen Gallagher

I. libmodulemd
  Modulemd 2.0 Public API
    Modulemd — User's Guide for libmodulemd
    Modulemd.BuildConfig — Internal representation of a module build configuration
    Modulemd.Buildopts — Provides hints to the build-system on how to build this module.
    Modulemd.Component — Pure virtual parent class for components that go into a module stream.
    Modulemd.ComponentModule — A module component that goes into a module stream.
    Modulemd.ComponentRpm — An rpm component that goes into a module stream.
    Modulemd Compression Helpers — Utility functions for working with compressed files.
    Modulemd.Defaults — Parent class for Default documents. See ModulemdDefaultsV1 for a specific type.
    Modulemd.DefaultsV1 — Object representing a defaults document (version 1)
    Modulemd.Dependencies — Object to represent build-time and runtime dependencies of a module stream.
    Modulemd Errors — Error codes for libmodulemd.
    Modulemd.Module — Collects all information about a module: all of its streams, defaults, etc.
    Modulemd.ModuleIndex — The primary interface to dealing with repodata in the module metadata format.
    Modulemd.ModuleIndexMerger — Class to aid in merging metadata from multiple repositories.
    Modulemd.ModuleStream — A parent class for all versions of ModulemdModuleStream objects.
    Modulemd.ModuleStreamV1 — The data to represent a stream of a module as described by a modulemd YAML document of version 1.
    Modulemd.ModuleStreamV2 — The data to represent a stream of a module as described by a modulemd YAML document of version 2.
    Modulemd.PackagerV3 — Internal representation of the modulemd-packager v3 format.
    Modulemd.Profile — Stores profile information for a module stream.
    Modulemd.RpmMapEntry — Provides an exploded and unexploded view of the NEVRA of an RPM artifact.
    Modulemd.ServiceLevel — Provides lifecycle information for a module stream.
    Modulemd.SubdocumentInfo — Stores information regarding a YAML subdocument in a stream.
    Modulemd.Translation — Translation information for a module stream.
    Modulemd.TranslationEntry — Contains the translated strings of a module stream for a specific locale.
    Modulemd.Obsoletes — Obsoletes information for a module stream.
  Modulemd 2.0 Private Object Methods
    modulemd-build-config-private
    Modulemd.Buildopts (Private) — ModulemdBuildopts methods that should be used only by internal consumers.
    Modulemd.Component (Private) — ModulemdComponent methods that should be used only by internal consumers.
    Modulemd.ComponentModule (Private) — ModulemdComponentModule methods that should be used only by internal consumers.
    Modulemd.ComponentRpm (Private) — ModulemdComponentRpm methods that should be used only by internal consumers.
    Modulemd Compression Helpers (Private) — Internal utility functions for working with compressed files.
    Modulemd.Dependencies (Private) — ModulemdDependencies methods that should be used only by internal consumers.
    Modulemd.Defaults (Private) — ModulemdDefaults methods that should only be used by internal consumers.
    Modulemd.DefaultsV1 (Private) — ModulemdDefaults methods that should only be used by internal consumers.
    Modulemd.Module (Private) — ModulemdModule methods that should be used only by internal consumers.
    Modulemd.ModuleIndex (Private) — ModulemdModuleIndex methods that should be used only by internal consumers.
    Modulemd.ModuleStream (Private) — ModulemdModuleStream methods that should only be used by internal consumers.
    Modulemd.ModuleStreamV1 (Private) — ModulemdModuleStreamV1 methods that should only be used by internal consumers.
    Modulemd.ModuleStreamV2 (Private) — ModulemdModuleStreamV2 methods that should only be used by internal consumers.
    Modulemd.PackagerV3 (Private) — ModulemdPackagerV3 methods that should only be used by internal consumers.
    Modulemd.Profile (Private) — ModulemdProfile methods that should be used only by internal consumers.
    Modulemd.RpmMapEntry (Private) — ModulemdRpmMapEntry methods that should be used only by internal consumers.
    Modulemd.ServiceLevel (Private) — ModulemdServiceLevel methods that should be used only by internal consumers.
    Modulemd.SubdocumentInfo (Private) — ModulemdSubdocumentInfo methods that should be used only by internal consumers.
    Modulemd.Translation (Private) — ModulemdTranslation methods that should be used only by internal consumers.
    Modulemd.TranslationEntry (Private) — ModulemdTranslationEntry methods that should be used only by internal consumers.
    Modulemd.Obsoletes (Private) — ModulemdObsoletes methods that should only be used by internal consumers.
  Modulemd 2.0 Private Developer Utilities
    Modulemd Utility Functions — Provides private utility functions for use within libmodulemd.
    YAML Manipulation Tools — Provides private YAML utilities for internal use.
    Internal Unit Test Utilities — Utility functions for use with unit tests.
II. resources
  Annotations
    Annotation Glossary
  2.0 API Index
  2.1 API Index
  2.2 API Index
  2.3 API Index
  2.4 API Index
  2.5 API Index
  2.6 API Index
  2.7 API Index
  2.8 API Index
  2.9 API Index
  2.10 API Index
  2.11 API Index
  2.13 API Index
  2.14 API Index
  Deprecated API Index
  Full API Index

Generated by GTK-Doc V1.33.1