From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:47519) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a5yZx-0007tm-EO for qemu-devel@nongnu.org; Mon, 07 Dec 2015 11:23:58 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1a5yZw-00017s-9M for qemu-devel@nongnu.org; Mon, 07 Dec 2015 11:23:57 -0500 Received: from mnementh.archaic.org.uk ([2001:8b0:1d0::1]:59056) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a5yZv-000159-Ve for qemu-devel@nongnu.org; Mon, 07 Dec 2015 11:23:56 -0500 From: Peter Maydell Date: Mon, 7 Dec 2015 16:23:43 +0000 Message-Id: <1449505425-32022-2-git-send-email-peter.maydell@linaro.org> In-Reply-To: <1449505425-32022-1-git-send-email-peter.maydell@linaro.org> References: <1449505425-32022-1-git-send-email-peter.maydell@linaro.org> Subject: [Qemu-devel] [PATCH 1/3] scripts: Add new clean-includes script to fix C include directives List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: Paolo Bonzini , Markus Armbruster , patches@linaro.org Add a new scripts/clean-includes, which can be used to automatically ensure that a C source file includes qemu/osdep.h first and doesn't then include any headers which osdep.h provides already. Signed-off-by: Peter Maydell --- scripts/clean-includes | 109 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100755 scripts/clean-includes diff --git a/scripts/clean-includes b/scripts/clean-includes new file mode 100755 index 0000000..1af1f82 --- /dev/null +++ b/scripts/clean-includes @@ -0,0 +1,109 @@ +#!/bin/sh -e +# +# Clean up QEMU #include lines by ensuring that qemu/osdep.h +# is the first include listed. +# +# Copyright (c) 2015 Linaro Limited +# +# Authors: +# Peter Maydell +# +# This work is licensed under the terms of the GNU GPL, version 2 +# or (at your option) any later version. See the COPYING file in +# the top-level directory. + +# Usage: +# clean-includes [--git subjectprefix] file ... +# +# If the --git subjectprefix option is given, then after making +# the changes to the files this script will create a git commit +# with the subject line "subjectprefix: Clean up includes" +# and a boilerplate commit message. + +# This script requires Coccinelle to be installed. + + +# The following one-liner may be handy for finding files to run this on. +# However some caution is required regarding files that might be part +# of the guest agent or standalone tests. + +# for i in `git ls-tree --name-only HEAD` ; do test -f $i && \ +# grep -E '^# *include' $i | head -1 | grep 'osdep.h' ; test $? != 0 && \ +# echo $i ; done + + +GIT=no + +if [ $# -ne 0 ] && [ "$1" = "--git" ]; then + if [ $# -eq 1 ]; then + echo "--git option requires an argument" + exit 1 + fi + GITSUBJ="$2" + GIT=yes + shift + shift +fi + +if [ $# -eq 0 ]; then + echo "Usage: clean-includes [--git subjectprefix] foo.c ..." + echo "(modifies the files in place)" + exit 1 +fi + +# Annoyingly coccinelle won't read a scriptfile unless its +# name ends '.cocci', so write it out to a tempfile with the +# right kind of name. +COCCIFILE="$(mktemp --suffix=.cocci)" + +trap 'rm -f -- "$COCCIFILE"' INT TERM HUP EXIT + +cat >"$COCCIFILE" < +) +EOT + + +for f in "$@"; do + # First, use coccinelle to add qemu/osdep.h before the first existing include + # (this will add two lines if the file uses both "..." and <...> #includes, + # but we will remove the extras in the next step) + spatch --in-place --no-show-diff --cocci-file "$COCCIFILE" "$f" + + # Now remove any duplicate osdep.h includes + perl -n -i -e 'print if !/#include "qemu\/osdep.h"/ || !$n++;' "$f" + + # Remove includes that osdep.h already provides + perl -n -i -e 'print if !/\s*#\s*include\s*(["<][^>"]*[">])/ || + ! (grep { $_ eq $1 } qw ( + "config-host.h" "qemu/compiler.h" "config.h" + + + + + "glib-compat.h" "qapi/error.h" + ))' "$f" + +done + +if [ "$GIT" = "yes" ]; then + git add -- "$@" + git commit --signoff -F - <