shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2025-01-08 21:17:47 +03:00
Code

docs: clarify JSON terms in COREDUMP_PACKAGE_METADATA

Browse Source
This commit is contained in:
Luca Boccassi 2021-11-30 12:36:16 +00:00
parent dc063e0978
commit bedd92b956
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/COREDUMP_PACKAGE_METADATA.md
View File

@ -34,9 +34,9 @@ multiple implementers might use it when building packages, or core file analyzer
so on. so on.
The metadata will be embedded in a single, new, 4-bytes-aligned, allocated, 0-padded, The metadata will be embedded in a single, new, 4-bytes-aligned, allocated, 0-padded,
read-only ELF header section, in a key-value JSON format. Implementers working on parsing read-only ELF header section, in a name-value JSON object format. Implementers working on parsing
core files should not assume a specific list of keys, but parse anything that is included core files should not assume a specific list of names, but parse anything that is included
in the section. Implementers working on build tools should strive to use the same key in the section. Implementers working on build tools should strive to use the same
names, for consistency. The most common will be listed here. When corresponding to the names, for consistency. The most common will be listed here. When corresponding to the
content of os-release, the values should match, again for consistency. content of os-release, the values should match, again for consistency.
@ -49,7 +49,7 @@ the original executable, debuginfo and sources, to further facilitate debugging.
SECTION: `.note.package` SECTION: `.note.package`
node-id: `0xcafe1a7e` node-id: `0xcafe1a7e`
Owner: `FDO` (FreeDesktop.org) Owner: `FDO` (FreeDesktop.org)
Value: a JSON string with the structure described below Value: a single JSON object encoded as a zero-terminated UTF-8 string
``` ```
* JSON payload * JSON payload
@ -67,6 +67,11 @@ Value: a JSON string with the structure described below
} }
``` ```
The format is a single JSON object, encoded as a zero-terminated `UTF-8` string.
Each name in the object shall be unique as per recommendations of
[RFC8259](https://datatracker.ietf.org/doc/html/rfc8259#section-4). Strings shall
not contain any control character, nor use `\uXXX` escaping.
When it comes to JSON numbers, this specification assumes that JSON parsers When it comes to JSON numbers, this specification assumes that JSON parsers
processing this information are capable of reproducing the full signed 53bit processing this information are capable of reproducing the full signed 53bit
integer range (i.e. -2⁵³+1…+2⁵³-1) as well as the full 64bit IEEE floating integer range (i.e. -2⁵³+1…+2⁵³-1) as well as the full 64bit IEEE floating