githubmirror/libmodulemd

modulemd/modulemd-docs.xml
164 строки6 KB
Merlin Mathesius
Documentation fixes and cleanup:
08 дек 2020, 22:37
08 дек 2020, 22:3745d5b56
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>Modulemd Reference Manual</title>
    <releaseinfo>
      for Modulemd &version;
    </releaseinfo>
    <authorgroup>
      <author>
        <firstname>Stephen</firstname>
        <surname>Gallagher</surname>
        <affiliation>
          <address>
            <email>sgallagh@redhat.com</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>
    <copyright>
      <year>2017-2018</year>
      <holder>Stephen Gallagher</holder>
    </copyright>
  </bookinfo>

  <reference id="modulemd-2.0">
    <title>libmodulemd</title>
    <partintro>
      <para>
        API Documentation for libmodulemd.
      </para>
    </partintro>
    <chapter>
      <title>Modulemd 2.0 Public API</title>
        <xi:include href="xml/modulemd.xml"/>
        <xi:include href="xml/modulemd-build-config.xml"/>
        <xi:include href="xml/modulemd-buildopts.xml"/>
        <xi:include href="xml/modulemd-component.xml"/>
        <xi:include href="xml/modulemd-component-module.xml"/>
        <xi:include href="xml/modulemd-component-rpm.xml"/>
        <xi:include href="xml/modulemd-compression.xml"/>
        <xi:include href="xml/modulemd-defaults.xml"/>
        <xi:include href="xml/modulemd-defaults-v1.xml"/>
        <xi:include href="xml/modulemd-dependencies.xml"/>
        <xi:include href="xml/modulemd-errors.xml"/>
        <xi:include href="xml/modulemd-module.xml"/>
        <xi:include href="xml/modulemd-module-index.xml"/>
        <xi:include href="xml/modulemd-module-index-merger.xml"/>
        <xi:include href="xml/modulemd-module-stream.xml"/>
        <xi:include href="xml/modulemd-module-stream-v1.xml"/>
        <xi:include href="xml/modulemd-module-stream-v2.xml"/>
        <xi:include href="xml/modulemd-packager-v3.xml"/>
        <xi:include href="xml/modulemd-profile.xml"/>
        <xi:include href="xml/modulemd-rpm-map-entry.xml"/>
        <xi:include href="xml/modulemd-service-level.xml"/>
        <xi:include href="xml/modulemd-subdocument-info.xml"/>
        <xi:include href="xml/modulemd-translation.xml"/>
        <xi:include href="xml/modulemd-translation-entry.xml"/>
        <xi:include href="xml/modulemd-obsoletes.xml"/>
    </chapter>
    <chapter>
      <title>Modulemd 2.0 Private Object Methods</title>
       <xi:include href="xml/modulemd-build-config-private.xml"/>
       <xi:include href="xml/modulemd-buildopts-private.xml"/>
       <xi:include href="xml/modulemd-component-private.xml"/>
       <xi:include href="xml/modulemd-component-module-private.xml"/>
       <xi:include href="xml/modulemd-component-rpm-private.xml"/>
       <xi:include href="xml/modulemd-compression-private.xml"/>
       <xi:include href="xml/modulemd-dependencies-private.xml"/>
       <xi:include href="xml/modulemd-defaults-private.xml"/>
       <xi:include href="xml/modulemd-defaults-v1-private.xml"/>
       <xi:include href="xml/modulemd-module-private.xml"/>
       <xi:include href="xml/modulemd-module-index-private.xml"/>
       <xi:include href="xml/modulemd-module-stream-private.xml"/>
       <xi:include href="xml/modulemd-module-stream-v1-private.xml"/>
       <xi:include href="xml/modulemd-module-stream-v2-private.xml"/>
       <xi:include href="xml/modulemd-packager-v3-private.xml"/>
       <xi:include href="xml/modulemd-profile-private.xml"/>
       <xi:include href="xml/modulemd-rpm-map-entry-private.xml"/>
       <xi:include href="xml/modulemd-service-level-private.xml"/>
       <xi:include href="xml/modulemd-subdocument-info-private.xml"/>
       <xi:include href="xml/modulemd-translation-private.xml"/>
       <xi:include href="xml/modulemd-translation-entry-private.xml"/>
       <xi:include href="xml/modulemd-obsoletes-private.xml"/>
    </chapter>
    <chapter>
      <title>Modulemd 2.0 Private Developer Utilities</title>
        <xi:include href="xml/modulemd-util.xml"/>
        <xi:include href="xml/modulemd-yaml.xml"/>
        <xi:include href="xml/test-utils.xml"/>
    </chapter>
  </reference>
  <reference id="modulemd-2.0-resources">
    <title>resources</title>
    <partintro>
      <para>
        Additional resources for libmodulemd
      </para>
    </partintro>
    <chapter>
      <title>Annotations</title>
      <xi:include href="xml/annotation-glossary.xml"/>
    </chapter>
    <chapter>
      <title>2.0 API Index</title>
      <xi:include href="xml/api-index-2.0.xml"/>
    </chapter>
    <chapter>
      <title>2.1 API Index</title>
      <xi:include href="xml/api-index-2.1.xml"/>
    </chapter>
    <chapter>
      <title>2.2 API Index</title>
      <xi:include href="xml/api-index-2.2.xml"/>
    </chapter>
    <chapter>
      <title>2.3 API Index</title>
      <xi:include href="xml/api-index-2.3.xml"/>
    </chapter>
    <chapter>
      <title>2.4 API Index</title>
      <xi:include href="xml/api-index-2.4.xml"/>
    </chapter>
    <chapter>
      <title>2.5 API Index</title>
      <xi:include href="xml/api-index-2.5.xml"/>
    </chapter>
    <chapter>
      <title>2.6 API Index</title>
      <xi:include href="xml/api-index-2.6.xml"/>
    </chapter>
    <chapter>
      <title>2.7 API Index</title>
      <xi:include href="xml/api-index-2.7.xml"/>
    </chapter>
    <chapter>
      <title>2.8 API Index</title>
      <xi:include href="xml/api-index-2.8.xml"/>
    </chapter>
    <chapter>
      <title>2.9 API Index</title>
      <xi:include href="xml/api-index-2.9.xml"/>
    </chapter>
    <chapter>
      <title>2.10 API Index</title>
      <xi:include href="xml/api-index-2.10.xml"/>
    </chapter>
    <chapter>
      <title>2.11 API Index</title>
      <xi:include href="xml/api-index-2.11.xml"/>
    </chapter>
    <chapter>
      <title>Deprecated API Index</title>
      <xi:include href="xml/api-index-deprecated.xml"/>
    </chapter>
    <chapter>
      <title>Full API Index</title>
      <xi:include href="xml/api-index-full.xml"/>
    </chapter>
  </reference>
</book>