[OS-BUILD PATCHv2 23/24] redhat/Makefile: Add some descriptions

[Prarit Bhargava (via Email Bridge)]

From: Prarit Bhargava <prarit(a)redhat.com&gt;

redhat/Makefile: Add some descriptions

Add some descriptive text about some of the Makefile sections.

Signed-off-by: Prarit Bhargava <prarit(a)redhat.com&gt;

diff --git a/redhat/Makefile b/redhat/Makefile
index blahblah..blahblah 100644
--- a/redhat/Makefile
+++ b/redhat/Makefile
@@ -1,4 +1,8 @@
-# deprecated variables
+#
+# Deprecated variables
+#
+# This section is intentionally left at the top of the Makefile so it won't be
ignored.
+#
 ifdef BREW_FLAGS
   # deprecated in 5.17.0
   $(warning WARNING: BREW_FLAGS will be deprecated in a later release, use BUILD_FLAGS
instead.)
@@ -139,6 +143,10 @@ PKGRELEASE:=$(PREBUILD)$(BUILD)$(BUILDID)
 RPMVERSION:=$(RPMKVERSION).$(RPMKPATCHLEVEL)-$(PKGRELEASE)
 SPECRELEASE:=$(PREBUILD)$(BUILD)%{?buildid}%{?dist}
 
+#
+# This conditional statement is where fedora, centos, and other (aka RHEL)
+# specific values should be set.
+#
 ifeq ("$(DISTRO)", "fedora")
   # A non-unified tarball means that the tarball is only upstream sources
   # and the patches get applied as a diff in the spec file
@@ -250,6 +258,14 @@ ifndef BUILD_FLAGS
   BUILD_FLAGS += $(TEST_FLAGS)
 endif
 
+#
+# Targets
+#
+# Do not place variable declarations below this line.  Variables are exported
+# to scripts called in the targets below and do not need to be passed on the
+# command-line.
+#
+
 default: dist-help
 
 dist-python-check:
diff --git a/redhat/Makefile.variables b/redhat/Makefile.variables
index blahblah..blahblah 100644
--- a/redhat/Makefile.variables
+++ b/redhat/Makefile.variables
@@ -1,3 +1,10 @@
+# Only the variables listed in this file, ../Makefile.rhelver, and
+# Makefile.rhpkg are available for command line modification.  There is no
+# guarantee on the stability of variables found in this file, or any other
+# redhat/ Makefile.
+#
+# Merge requests to include additional variables in _this_ file must include
+# details of why the variable must be exported.
 
 # Variables below should be changed as needed for building on a different
 # branch, or with a different upstream branch. This should be the only

--
https://gitlab.com/cki-project/kernel-ark/-/merge_requests/1641