From: Luca Boccassi <luca.boccassi@microsoft.com>
Date: Thu, 6 May 2021 13:38:47 +0000 (+0100)
Subject: docs/COREDUMP_PACKAGE_METADATA.md: add table with well-known keys and their definition
X-Git-Tag: v249-rc1~283^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F19523%2Fhead;p=thirdparty%2Fsystemd.git

docs/COREDUMP_PACKAGE_METADATA.md: add table with well-known keys and their definition
---

diff --git a/docs/COREDUMP_PACKAGE_METADATA.md b/docs/COREDUMP_PACKAGE_METADATA.md
index 6ef746f2465..f27f835064d 100644
--- a/docs/COREDUMP_PACKAGE_METADATA.md
+++ b/docs/COREDUMP_PACKAGE_METADATA.md
@@ -60,8 +60,8 @@ Value: a JSON string with the structure described below
      "osVersion":"33",
      "name":"coreutils",
      "version": "4711.0815.fc13.arm32",
-     "osCpe":               # A CPE name for the operating system, `CPE_NAME` from os-release is a good default
-     "debugInfoUrl": "https://debuginfod.fedoraproject.org/",
+     "osCpe": "cpe:/o:fedoraproject:fedora:33",          # A CPE name for the operating system, `CPE_NAME` from os-release is a good default
+     "debugInfoUrl": "https://debuginfod.fedoraproject.org/"
 }
 ```
 
@@ -108,3 +108,18 @@ SECTIONS
 }
 INSERT AFTER .note.gnu.build-id;
 ```
+
+## Well-known keys
+
+The metadata format is intentionally left open, so that vendors can add their own information.
+A set of well-known keys is defined here, and hopefully shared among all vendors.
+
+| Key name     | Key description                                                          | Example value                         |
+|--------------|--------------------------------------------------------------------------|---------------------------------------|
+| type         | The packaging type                                                       | rpm                                   |
+| os           | The OS name, typically corresponding to ID in os-release                 | fedora                                |
+| osVersion    | The OS version, typically corresponding to VERSION_ID in os-release      | 33                                    |
+| name         | The source package name                                                  | coreutils                             |
+| version      | The source package version                                               | 4711.0815.fc13.arm32                  |
+| osCpe        | A CPE name for the OS, typically corresponding to CPE_NAME in os-release | cpe:/o:fedoraproject:fedora:33        |
+| debugInfoUrl | The debuginfod server url, if available                                  | https://debuginfod.fedoraproject.org/ |