]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
docs: clarify ELF note usage in COREDUMP_PACKAGE_METADATA 21578/head
authorLuca Boccassi <luca.boccassi@microsoft.com>
Tue, 30 Nov 2021 14:42:43 +0000 (14:42 +0000)
committerLuca Boccassi <luca.boccassi@microsoft.com>
Tue, 30 Nov 2021 14:42:43 +0000 (14:42 +0000)
docs/COREDUMP_PACKAGE_METADATA.md

index 461cb600c59e56f27e1ea8ff9e48fba3e920e8da..db75ad143258fc754939f22401e0de2c62b8becd 100644 (file)
@@ -36,9 +36,9 @@ so on.
 The metadata will be embedded in a single, new, 4-bytes-aligned, allocated, 0-padded,
 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.
+in the section, and should look for the note using the `note type`. 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.
 
 If available, the metadata should also include the debuginfod server URL that can provide
 the original executable, debuginfo and sources, to further facilitate debugging.
@@ -47,7 +47,7 @@ the original executable, debuginfo and sources, to further facilitate debugging.
 
 ```
 SECTION: `.note.package`
-node-id: `0xcafe1a7e`
+note type: `0xcafe1a7e`
 Owner: `FDO` (FreeDesktop.org)
 Value: a single JSON object encoded as a zero-terminated UTF-8 string
 ```