From: Markus Armbruster <armbru@redhat.com>
Date: Thu, 2 Feb 2023 13:38:14 +0000 (+0100)
Subject: scripts/clean-includes: Improve --git commit message
X-Git-Tag: qemu-xen-4.18.0-rc5~327^2~15
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=d598d9746e87cea8e92acd0d4f4320fe5d854440;p=qemu-xen.git

scripts/clean-includes: Improve --git commit message

The script drops #include "qemu/osdep.h" from headers.  Mention it in
the commit message it uses for --git.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Message-Id: <20230202133830.2152150-5-armbru@redhat.com>
---

diff --git a/scripts/clean-includes b/scripts/clean-includes
index f0466a6262..58e1607a82 100755
--- a/scripts/clean-includes
+++ b/scripts/clean-includes
@@ -193,11 +193,17 @@ if [ "$GIT" = "yes" ]; then
     git commit --signoff -F - <<EOF
 $GITSUBJ: Clean up includes
 
-Clean up includes so that osdep.h is included first and headers
-which it implies are not included manually.
-
 This commit was created with scripts/clean-includes.
 
+All .c should include qemu/osdep.h first.  The script performs three
+related cleanups:
+
+* Ensure .c files include qemu/osdep.h first.
+* Including it in a .h is redundant, since the .c  already includes
+  it.  Drop such inclusions.
+* Likewise, including headers qemu/osdep.h includes is redundant.
+  Drop these, too.
+
 EOF
 
 fi