aboutsummaryrefslogtreecommitdiff
path: root/scripts/clean-includes
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2023-02-02 14:38:14 +0100
committerMarkus Armbruster <armbru@redhat.com>2023-02-08 07:16:23 +0100
commitd598d9746e87cea8e92acd0d4f4320fe5d854440 (patch)
tree09be5af2d79f3d0d9b888424af51dd19a9a511f8 /scripts/clean-includes
parent6a7f0515fd8f12377622dbbda1e794f28511192d (diff)
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>
Diffstat (limited to 'scripts/clean-includes')
-rwxr-xr-xscripts/clean-includes12
1 files changed, 9 insertions, 3 deletions
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