diff options
| author | Luca Boccassi <luca.boccassi@microsoft.com> | 2021-05-06 14:38:47 +0100 |
|---|---|---|
| committer | Luca Boccassi <luca.boccassi@microsoft.com> | 2021-05-06 16:58:43 +0100 |
| commit | 201962ef46f717d612512a2f5c1414f6d82b8869 (patch) | |
| tree | 02590dd484dad750e8dee1ead012a5e53fa972be /docs/COREDUMP_PACKAGE_METADATA.md | |
| parent | 4f90b052e5a643884ae2d78d99940b818605752f (diff) | |
| download | systemd-201962ef46f717d612512a2f5c1414f6d82b8869.tar.gz | |
docs/COREDUMP_PACKAGE_METADATA.md: add table with well-known keys and their definition
Diffstat (limited to 'docs/COREDUMP_PACKAGE_METADATA.md')
| -rw-r--r-- | docs/COREDUMP_PACKAGE_METADATA.md | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/COREDUMP_PACKAGE_METADATA.md b/docs/COREDUMP_PACKAGE_METADATA.md index 6ef746f246..f27f835064 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/ | |