Skip to content

Commit

Permalink
docs: clarify ELF note usage in COREDUMP_PACKAGE_METADATA
Browse files Browse the repository at this point in the history
  • Loading branch information
bluca committed Nov 30, 2021
1 parent bedd92b commit 45f822c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/COREDUMP_PACKAGE_METADATA.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
```
Expand Down

0 comments on commit 45f822c

Please sign in to comment.