From nobody Tue Jul 2 18:32:47 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1545234626191957.2268754737169; Wed, 19 Dec 2018 07:50:26 -0800 (PST) Received: from localhost ([::1]:60826 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gZdvp-0005IB-Fu for importer@patchew.org; Wed, 19 Dec 2018 10:38:45 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:56185) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gZded-00072M-D1 for qemu-devel@nongnu.org; Wed, 19 Dec 2018 10:21:00 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gZdeZ-0004xX-6W for qemu-devel@nongnu.org; Wed, 19 Dec 2018 10:20:59 -0500 Received: from mx1.redhat.com ([209.132.183.28]:45709) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gZdeX-0004vO-3R for qemu-devel@nongnu.org; Wed, 19 Dec 2018 10:20:54 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 884C3804E4 for ; Wed, 19 Dec 2018 15:20:51 +0000 (UTC) Received: from donizetti.redhat.com (ovpn-112-76.ams2.redhat.com [10.36.112.76]) by smtp.corp.redhat.com (Postfix) with ESMTP id B7D5317197 for ; Wed, 19 Dec 2018 15:20:50 +0000 (UTC) From: Paolo Bonzini To: qemu-devel@nongnu.org Date: Wed, 19 Dec 2018 16:19:15 +0100 Message-Id: <20181219151917.3874-34-pbonzini@redhat.com> In-Reply-To: <20181219151917.3874-1-pbonzini@redhat.com> References: <20181219151917.3874-1-pbonzini@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.27]); Wed, 19 Dec 2018 15:20:51 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PULL 33/35] scripts: add script to convert multiline comments into 4-line format X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Since we're adding checkpatch rules to enforce 4-line multiline comment format, i.e. with lone /* and */, this script can be run on existing code so that the comment style does not become inconsistent within a file. The alternative to awk-in-a-shell-script could be Perl, which also supports -i directly, but a2p seems to have bitrotten and I didn't quite feel like writing this twice... Signed-off-by: Paolo Bonzini --- scripts/fix-multiline-comments.sh | 62 +++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100755 scripts/fix-multiline-comments.sh diff --git a/scripts/fix-multiline-comments.sh b/scripts/fix-multiline-comm= ents.sh new file mode 100755 index 0000000000..93f9b10669 --- /dev/null +++ b/scripts/fix-multiline-comments.sh @@ -0,0 +1,62 @@ +#! /bin/sh +# +# Fix multiline comments to match CODING_STYLE +# +# Copyright (C) 2018 Red Hat, Inc. +# +# Author: Paolo Bonzini +# +# Usage: scripts/fix-multiline-comments.sh [-i] FILE... +# +# -i edits the file in place (requires gawk 4.1.0). +# +# Set the AWK environment variable to choose the awk interpreter to use +# (default 'awk') + +if test "$1" =3D -i; then + # gawk extension + inplace=3D"-i inplace" + shift +fi +${AWK-awk} $inplace 'BEGIN { indent =3D -1 } +{ + line =3D $0 + # apply a star to the indent on lines after the first + if (indent !=3D -1) { + if (line =3D=3D "") { + line =3D sp " *" + } else if (substr(line, 1, indent + 2) =3D=3D sp " ") { + line =3D sp " *" substr(line, indent + 3) + } + } + + is_lead =3D (line ~ /^[ \t]*\/\*/) + is_trail =3D (line ~ /\*\//) + if (is_lead && !is_trail) { + # grab the indent at the start of a comment, but not for + # single-line comments + match(line, /^[ \t]*\/\*/) + indent =3D RLENGTH - 2 + sp =3D substr(line, 1, indent) + } + + # the regular expression filters out lone /*, /**, or */ + if (indent !=3D -1 && !(line ~ /^[ \t]*(\/\*+|\*\/)[ \t]*$/)) { + if (is_lead) { + # split the leading /* or /** on a separate line + match(line, /^[ \t]*\/\*+/) + lead =3D substr(line, 1, RLENGTH) + match(line, /^[ \t]*\/\*+[ \t]*/) + line =3D lead "\n" sp " *" substr(line, RLENGTH) + } + if (is_trail) { + # split the trailing */ on a separate line + match(line, /[ \t]*\*\//) + line =3D substr(line, 1, RSTART - 1) "\n" sp " */" + } + } + if (is_trail) { + indent =3D -1 + } + print line +}' "$@" --=20 2.20.1