From 0c3204371923b3d2690a39acdf7536f43798171f Mon Sep 17 00:00:00 2001
From: Denys Vlasenko <dvlasenk@redhat.com>
Date: Fri, 28 Apr 2023 15:56:49 +0200
Subject: [PATCH] README.md: add notes to understand what is done by which file

Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
---
 README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 73 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f8faece..ac54f6e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,75 @@
 # kernel-srpm-macros
 
-The kernel-srpm-macros package
\ No newline at end of file
+The kernel-srpm-macros package
+
+This source package results in two "binary" packages, kernel-rpm-macros
+and kernel-srpm-macros. The role and locations of files is as follows:
+
+kernel-srpm-macros:
+
+/usr/lib/rpm/fileattrs/kmod.attr
+	For /lib/modules/XYZ/modules.builtin and .../MODULE.ko.XYZ
+	specifies a Lua script to generate kmod(MODULE.ko)
+	"Provides:" deps
+/usr/lib/rpm/macros.d/macros.kernel-srpm
+	?
+
+kernel-rpm-macros:
+
+/usr/lib/rpm/redhat/brp-kmod-restore-perms
+	?
+/usr/lib/rpm/redhat/brp-kmod-set-exec-bit
+	?
+
+/usr/lib/rpm/redhat/find-provides.ksyms
+	Runs from rpmbuild at the end of kernel builds and 3rd party module
+	builds, to extract
+	kernel(SYMBOL)=0xHASH "Provides:" deps from modules in kernel packages,
+	and ksym(SYMBOL)=0xHASH for 3rd party modules.
+	Takes input list of files on stdin.
+/usr/lib/rpm/fileattrs/provided_ksyms.attr
+	For newer rpmbuild with "internal dependency generators",
+	this file specifies that find-provides.ksyms should be run
+	only on .ko.XYZ files
+	(with "external dependency generators", the script needs to
+	filter out the files by itself).
+
+/usr/lib/rpm/redhat/find-requires.ksyms
+	?
+/usr/lib/rpm/fileattrs/required_ksyms.attr
+	For newer rpmbuild with "internal dependency generators",
+	this file specifies that find-requires.ksyms should be run
+	only on .ko.XYZ files, and not for /lib/modules/XYZ/kernel/*
+	(IOW: only for building 3rd-party modules)
+
+/usr/lib/rpm/redhat/find-provides.d/modalias.prov
+	Runs from rpmbuild at the end of kernel builds and 3rd party module
+	builds, to extract
+	modalias(pci:SOMETHING)=OPTIONALLY_VERSION "Provides:" deps from modules
+	in kernel and 3rd party modules packages.
+	Takes input list of files on stdin.
+/usr/lib/rpm/fileattrs/modalias.attr
+	For newer rpmbuild with "internal dependency generators",
+	this file specifies that modalias.prov should be run
+	only on .ko.XYZ files
+
+/usr/lib/rpm/redhat/find-provides.d/firmware.prov
+	?
+
+/usr/lib/rpm/kabi.sh
+	Runs from rpmbuild at the end of kernel build to extract
+	kernel(SYMBOL)=0xHASH "Provides:" deps.
+/usr/lib/rpm/fileattrs/kabi.attr
+	For newer rpmbuild with "internal dependency generators",
+	this file specifies that kabi.sh should be run on
+	/boot/symvers-* and /lib/modules/XYZ/symvers).gz
+
+/usr/lib/rpm/macros.d/macros.kmp
+	?
+
+/usr/lib/rpm/redhat/kmodtool
+	?
+/usr/lib/rpm/redhat/rpmsort
+	?
+/usr/lib/rpm/redhat/symset-table
+	?