From patchwork Wed Aug 5 10:25:50 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Zijlstra X-Patchwork-Id: 11701721 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 8D47E913 for ; Wed, 5 Aug 2020 10:35:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 700DD206B6 for ; Wed, 5 Aug 2020 10:35:02 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="D48Bi4O/" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727941AbgHEK2c (ORCPT ); Wed, 5 Aug 2020 06:28:32 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:43898 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728119AbgHEK0T (ORCPT ); Wed, 5 Aug 2020 06:26:19 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2DF9AC0617A1; Wed, 5 Aug 2020 03:25:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Type:MIME-Version:Message-ID: Subject:Cc:To:From:Date:Sender:Reply-To:Content-Transfer-Encoding:Content-ID: Content-Description:In-Reply-To:References; bh=EgLuoy51jN5BCDfpowjvn/C6CCPgestz5KEkr0EylHg=; b=D48Bi4O/xIUdkOl8ASViOO/4Qn qTmxKGEPzQYyL2+G+R9sz5mPzXIcsdpAu61JPqlqB+SqmDKLEEQLAXLqQVdirVLnZiaktVkziOmTS ZODos8mb1qDk8msepdHWej00l7W9cq4Uzg02VD0hllTmrbPf4YcCaEzZCCV++O+b6W9tSsKXQ/gdd xW7D8JXXHQyKUMcyJxcCI8HZWQJe1UatrpLjx5yrpREAUBHTtiE2z0TQan+2i7qBRtaCLpaqsWYSM JUkgCl/kjAuG0zp0JO5/vk6gStU3hPGYul3cKadsKHW+CaujXc9qHjXXVMwNGqo0celd3rLLm8WuN +37zncQg==; Received: from j217100.upc-j.chello.nl ([24.132.217.100] helo=noisy.programming.kicks-ass.net) by casper.infradead.org with esmtpsa (Exim 4.92.3 #3 (Red Hat Linux)) id 1k3GcL-0004td-Ap; Wed, 05 Aug 2020 10:25:53 +0000 Received: from hirez.programming.kicks-ass.net (hirez.programming.kicks-ass.net [192.168.1.225]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by noisy.programming.kicks-ass.net (Postfix) with ESMTPS id BA3A33012DC; Wed, 5 Aug 2020 12:25:50 +0200 (CEST) Received: by hirez.programming.kicks-ass.net (Postfix, from userid 1000) id 653F42B7C12A6; Wed, 5 Aug 2020 12:25:50 +0200 (CEST) Date: Wed, 5 Aug 2020 12:25:50 +0200 From: peterz@infradead.org To: yamada.masahiro@socionext.com Cc: linux-kernel@vger.kernel.org, linux-kbuild@vger.kernel.org Subject: [PATCH] scipts/tags.sh: Add custom sort order Message-ID: <20200805102550.GO2674@hirez.programming.kicks-ass.net> MIME-Version: 1.0 Content-Disposition: inline Sender: linux-kbuild-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org One long standing annoyance I have with using vim-tags is that our tags file is not properly sorted. That is, the sorting exhuberant Ctags does is only on the tag itself. The problem with that is that, for example, the tag 'mutex' appears a mere 505 times, 492 of those are structure members. However it is _far_ more likely that someone wants the struct definition when looking for the mutex tag than any of those members. However, due to the nature of the sorting, the struct definition will not be first. So add a script that does a custom sort of the tags file, taking the tag kind into account. The kind ordering is roughly: 'type', 'function', 'macro', 'enum', rest. Signed-off-by: Peter Zijlstra (Intel) --- scripts/sort-tags.awk | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++ scripts/tags.sh | 8 +++++- 2 files changed, 86 insertions(+), 1 deletion(-) diff --git a/scripts/sort-tags.awk b/scripts/sort-tags.awk new file mode 100755 index 000000000000..1eb50406c9d3 --- /dev/null +++ b/scripts/sort-tags.awk @@ -0,0 +1,79 @@ +#!/usr/bin/awk -f + +# $ ctags --list-kinds +# C +# c classes +# s structure names +# t typedefs +# g enumeration names +# u union names +# n namespaces + +# f function definitions +# p function prototypes [off] +# d macro definitions + +# e enumerators (values inside an enumeration) +# m class, struct, and union members +# v variable definitions + +# l local variables [off] +# x external and forward variable declarations [off] + +BEGIN { + FS = "\t" + + sort = "LC_ALL=C sort" + + # our sort order for C kinds: + order["c"] = "A" + order["s"] = "B" + order["t"] = "C" + order["g"] = "D" + order["u"] = "E" + order["n"] = "F" + order["f"] = "G" + order["p"] = "H" + order["d"] = "I" + order["e"] = "J" + order["m"] = "K" + order["v"] = "L" + order["l"] = "M" + order["x"] = "N" +} + +# pass through header +/^!_TAG/ { + print $0 + next +} + +{ + # find 'kinds' + for (i = 1; i <= NF; i++) { + if ($i ~ /;"$/) { + kind = $(i+1) + break; + } + } + + # create sort key + if (order[kind]) + key = $1 order[kind]; + else + key = $1 "Z"; + + # get it sorted + print key "\t" $0 |& sort +} + +END { + close(sort, "to") + while ((sort |& getline) > 0) { + # strip key + sub(/[^[:space:]]*[[:space:]]*/, "") + print $0 + } + close(sort) +} + diff --git a/scripts/tags.sh b/scripts/tags.sh index 4e18ae5282a6..93d729392a7b 100755 --- a/scripts/tags.sh +++ b/scripts/tags.sh @@ -251,6 +251,8 @@ setup_regex() exuberant() { + rm -f tags.unsorted + setup_regex exuberant asm c all_target_sources | xargs $1 -a \ -I __initdata,__exitdata,__initconst,__ro_after_init \ @@ -266,12 +268,16 @@ exuberant() -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \ -I static,const \ --extra=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \ + --sort=no -o tags.unsorted \ "${regex[@]}" setup_regex exuberant kconfig all_kconfigs | xargs $1 -a \ - --langdef=kconfig --language-force=kconfig "${regex[@]}" + --langdef=kconfig --language-force=kconfig --sort=no \ + -o tags.unsorted "${regex[@]}" + scripts/sort-tags.awk tags.unsorted > tags + rm -f tags.unsorted } emacs()