- # Document type identifier

- document: modulemd

- # Module metadata format version

- version: 1

- data:

-     # Module name, optional

-     # Typically filled in by the buildsystem, using the VCS repository

-     # name as the name of the module.

-     # name: toolchain

-     # Module update stream, optional

-     # Typically filled in by the buildsystem, using the VCS branch name

-     # as the name of the stream.

-     # stream: master

-     # Module version, integer, optional, cannot be negative

-     # Typically filled in by the buildsystem, using the VCS commit

-     # timestamp.  Module version defines upgrade path for the particular

-     # update stream.

-     # version: 2

-     # A short summary describing the module, required

-     summary: Platform for building C and C++ applications

-     # A verbose description of the module, required

-     description: >

-         Fedora variant of Developer Toolset's C/C++ Toolchain from Software Collections.

-     # Module and content licenses in the Fedora license identifier

-     # format, required

-     license:

-         # Module license, required

-         # This list covers licenses used for the module metadata, SPEC

-         # files or extra patches

-         module:

-             - MIT

-         # Content license, optional

-         # A list of licenses used by the packages in the module.

-         # This should be populated by build tools.

-         content: []

-     # Extensible metadata block

-     # A dictionary of user-defined keys and values.

-     # Optional.  Defaults to an empty dictionary.

-     xmd: {}

-     # Module dependencies, if any.  Optional.

-     # TODO: Provides, conflicts, obsoletes, recommends, etc.

-     # TODO: Stream name globbing or regular expression support

-     dependencies:

-         # Build dependencies of this module, optional

-         # Keys are module names, values are the stream names

-         # These modules define the buildroot for this module

-         buildrequires:

-             bootstrap: master

-         # Run-time dependencies of this module, optional

-         # Keys are module names, values are their stream names

-         requires: []

-     # References to external resources, typically upstream, optional

-     references:

-         # Upstream community website, if it exists, optional

-         community: http://www.example.com/

-         # Upstream documentation, if it exists, optional

-         documentation: http://www.example.com/

-         # Upstream bug tracker, if it exists, optional

-         tracker: http://www.example.com/

-     # Profiles define the end user's use cases for the module and consist

-     # of package lists of components to be installed by default if this

-     # module is enabled.  The keys here are the profile names and contain

-     # package lists by component type. See the example.

-     # Optional, defaults to no profile definitions.

-     # TODO: Profiles deserve detailed documentation.

-     profiles:

-         # The default profile, used unless any other profile was selected.

-         # Optional, defaults to empty lists.

-         default:

-             rpms:

-                 - gcc

-                 - gcc-c++

-                 - gcc-gfortran

-                 - gdb

-                 - make

-     # Module API

-     # TODO: Define more API types

-     api:

-         # The module's public RPM-level API.

-         # A list of binary RPM names that are considered to be the

-         # main and stable feature of the module; binary RPMs not listed

-         # here are considered "unsupported" or "implementation details".

-         # In the example here we don't list the xyz package as it's only

-         # included as a dependency of xxx.  However, we list a subpackage

-         # of bar, bar-extras.

-         # Optional, defaults to an empty list.

-         rpms:

-             - gcc

-             - gcc-c++

-             - gcc-gfortran

-             - gdb

-             - make

-     # Module component filters

-     filter:

-         # RPM names not to be included in the module.

-         # By default, all built binary RPMs are included.  In the example

-         # we exclude a subpackage of bar, bar-nonfoo from our module.

-         # Optional, defaults to an empty list.

-         rpms: []

-     # Functional components of the module, optional

-     components:

-         # RPM content of the module, optional

-         # Keys are the VCS/SRPM names, values dictionaries holding

-         # additional information.

-         # TODO: Define architectures to build for

-         rpms:

-             gcc:

-                 ref: f26

-                 rationale: API.

-             gdb:

-                 ref: f26

-                 rationale: API.

-             make:

-                 ref: f26

-                 rationale: API.

-         # Module content of this module

-         # Included modules are built in the shared buildroot, together with

-         # other included content.  Keys are module names, values additional

-         # component information.

-         # Optional

-         modules: {}