UBUNTU: [Packaging] annotations: document annotations headers

Signed-off-by: Andrea Righi <andrea.righi@canonical.com>
2023-03-09 22:17:21 +01:00
parent a5484caf97
commit 2488fc69ee
1 changed files with 29 additions and 0 deletions
@@ -123,6 +123,35 @@ Moreover, an additional kernelconfig commands are provided
 - `migrateconfigs`: automatically merge all the previous configs into
   annotations (local changes still need to be committed)

+Annotations headers
+===================
+
+The main annotations file should contain a header to define the architectures
+and flavours that are supported.
+
+Here is the format of the header for the generic kernel:
+```
+# Menu: HEADER
+# FORMAT: 4
+# ARCH: amd64 arm64 armhf ppc64el riscv64 s390x
+# FLAVOUR: amd64-generic arm64-generic arm64-generic-64k armhf-generic armhf-generic-lpae ppc64el-generic riscv64-generic s390x-generic
+
+```
+
+Example header of a derivative (linux-aws):
+```
+# Menu: HEADER
+# FORMAT: 4
+# ARCH: amd64 arm64
+# FLAVOUR: amd64-aws arm64-aws
+# FLAVOUR_DEP: {'amd64-aws': 'amd64-generic', 'arm64-aws': 'arm64-generic'}
+
+include "../../debian.master/config/annotations"
+
+# Below you can define only the specific linux-aws configs that differ from linux generic
+
+```
+
 Pros and Cons
 =============