From 0037e4bdf5fcab5456ba9caf9cfaa78f1eabb6dd Mon Sep 17 00:00:00 2001
From: Christian Kellner <christian@kellner.me>
Date: Thu, 22 Oct 2020 18:39:03 +0200
Subject: [PATCH] stages/rpm: document returned metadata

Document what metadata we return from the stage via the metadata
osbuild API.
---
 stages/org.osbuild.rpm | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/stages/org.osbuild.rpm b/stages/org.osbuild.rpm
index f7bbb099..031dd047 100755
--- a/stages/org.osbuild.rpm
+++ b/stages/org.osbuild.rpm
@@ -18,6 +18,13 @@ Uses the following binaries from the host:
     * `rpmkeys` to import keys and to verify signatures for each package
     * `sh`, `mkdir`, `mount`, `chmod` to prepare the target tree for `rpm`
     * `rpm` to install packages into the target tree
+
+This stage will return the following metadata via the osbuild API:
+  packages: a list of objects representing the installed packages,
+            with information about:
+              name, version, release,
+            and optionally:
+              epoch, arch, sigmd5, sigpgp, siggpg
 """