particle-os/debian-koji
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix doc headers

Browse source
This commit is contained in:
Mike McLean 2016-08-24 21:11:32 -04:00
parent c1450f1a65
commit caf5b86798
1 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/source/content_generator_metadata.rst
View file

@ -1,5 +1,6 @@
========================================
Koji Content Generator Metadata Proposal Koji Content Generator Metadata Proposal
---------------------------------------- ========================================
This document describes the proposed Koji Content Generator Metadata This document describes the proposed Koji Content Generator Metadata
Format (version 0). This is the metadata that should be provided by a Format (version 0). This is the metadata that should be provided by a
@ -9,7 +10,7 @@ Generators <Koji/ContentGenerators>`__, please email
koji-devel@lists.fedorahosted.org. koji-devel@lists.fedorahosted.org.
Format Format
------ ======
Content Generator Metadata for a single build is provided as a JSON map. Content Generator Metadata for a single build is provided as a JSON map.
The map has four top-level entries: The map has four top-level entries:
@ -23,14 +24,14 @@ The map has four top-level entries:
and managed by Brew. and managed by Brew.
metadata\_version metadata\_version
~~~~~~~~~~~~~~~~~ -----------------
This is an integer which indicates the version of the metadata format This is an integer which indicates the version of the metadata format
contained in this file. It will start at 0 and be incremented as the contained in this file. It will start at 0 and be incremented as the
metadata format evolves. metadata format evolves.
build build
~~~~~ -----
The build map contains the following entries: The build map contains the following entries:
@ -44,7 +45,7 @@ The build map contains the following entries:
- extra: A map of extra metadata associated with the build. - extra: A map of extra metadata associated with the build.
buildroots buildroots
~~~~~~~~~~ ----------
Each map in the buildroots list contains the following entries: Each map in the buildroots list contains the following entries:
@ -108,7 +109,7 @@ Each map in the buildroots list contains the following entries:
run the build. run the build.
output output
~~~~~~ ------
Each map in the output list contains the following entries: Each map in the output list contains the following entries:
@ -136,7 +137,7 @@ Each map in the output list contains the following entries:
available. available.
Example Metadata JSON Example Metadata JSON
--------------------- =====================
The below JSON is based loosely on the output of a docker image build. The below JSON is based loosely on the output of a docker image build.