From 98acae1f2135f8c2667c1acec8875ab4ad4aa4d0 Mon Sep 17 00:00:00 2001 From: Luca Boccassi Date: Tue, 26 Oct 2021 12:49:39 +0100 Subject: [PATCH] docs/COREDUMP_PACKAGE_METADATA: ELF section should be read-only and 4-bytes-aligned --- docs/COREDUMP_PACKAGE_METADATA.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/COREDUMP_PACKAGE_METADATA.md b/docs/COREDUMP_PACKAGE_METADATA.md index 1ff10d385de..fbbba1464c2 100644 --- a/docs/COREDUMP_PACKAGE_METADATA.md +++ b/docs/COREDUMP_PACKAGE_METADATA.md @@ -33,9 +33,9 @@ This document will attempt to define a common metadata format specification, so multiple implementers might use it when building packages, or core file analyzers, and so on. -The metadata will be embedded in a single, new 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. +The metadata will be embedded in a single, new, 4-bytes-aligned, 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 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. -- 2.47.3