diff options
| author | Luca Boccassi <luca.boccassi@microsoft.com> | 2021-11-30 12:36:16 +0000 |
|---|---|---|
| committer | Luca Boccassi <luca.boccassi@microsoft.com> | 2021-11-30 12:36:16 +0000 |
| commit | bedd92b956f42403e1dbc400ccda8f18efee9e68 (patch) | |
| tree | cbe9dc00c238e0d7ad57443c43a7e8acb5590351 /docs/COREDUMP_PACKAGE_METADATA.md | |
| parent | dc063e0978ed5deb534554a7aeb113295586059a (diff) | |
| download | systemd-bedd92b956f42403e1dbc400ccda8f18efee9e68.tar.gz | |
docs: clarify JSON terms in COREDUMP_PACKAGE_METADATA
Diffstat (limited to 'docs/COREDUMP_PACKAGE_METADATA.md')
| -rw-r--r-- | docs/COREDUMP_PACKAGE_METADATA.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/COREDUMP_PACKAGE_METADATA.md b/docs/COREDUMP_PACKAGE_METADATA.md index 705d5d695a..461cb600c5 100644 --- a/docs/COREDUMP_PACKAGE_METADATA.md +++ b/docs/COREDUMP_PACKAGE_METADATA.md @@ -34,9 +34,9 @@ multiple implementers might use it when building packages, or core file analyzer so on. 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 -core files should not assume a specific list of keys, but parse anything that is included -in the section. Implementers working on build tools should strive to use the same key +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 names, but parse anything that is included +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 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` node-id: `0xcafe1a7e` 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 @@ -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 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 |