linux-kernel - [PATCH] scripts/tags.sh: allow only selected directories to be indexed

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <Y5OKDvbGk4Kro6MK@mail.google.com>
Date:   Sat, 10 Dec 2022 08:18:38 +1300
From:   Paulo Miguel Almeida <paulo.miguel.almeida.rodenas@...il.com>
To:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Cristian Ciocaltea <cristian.ciocaltea@...labora.com>,
        Vipin Sharma <vipinsh@...gle.com>
Cc:     linux-kernel@...r.kernel.org,
        paulo.miguel.almeida.rodenas@...il.com
Subject: [PATCH] scripts/tags.sh: allow only selected directories to be
 indexed

It's common for drivers that share same physical components to also
duplicate source code (or at least portions of it). A good example is
both drivers/gpu/drm/amdgpu/* and drivers/gpu/drm/radeon/* have a header
file called atombios.h.

While their contents aren't the same, a lot of their structs have
the exact same names which makes navigating through the code base a bit
messy as cscope will show up 'references' across drivers which aren't
exactly correct.

This patch makes it possible for the devs to specify which folders
they want to include as part of the find_other_sources function if a
makefile variable OTHERSRCDIRS is present, otherwise the original
behaviour is kept.

Example:
	make ARCH=x86 OTHERSRCDIRS=drivers/gpu/drm/radeon,tools cscope

Signed-off-by: Paulo Miguel Almeida <paulo.miguel.almeida.rodenas@...il.com>
---
 scripts/tags.sh | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/scripts/tags.sh b/scripts/tags.sh
index e137cf15aae9..958c07c4ac4a 100755
--- a/scripts/tags.sh
+++ b/scripts/tags.sh
@@ -59,12 +59,17 @@ find_include_sources()
 }

 # find sources in rest of tree
-# we could benefit from a list of dirs to search in here
 find_other_sources()
 {
-	find ${tree}* $ignore \
-	     \( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) -prune -o \
-	       -name "$1" -not -type l -print;
+	find_def_params="-name $1 -not -type l -print"
+	if [ -n "${OTHERSRCDIRS}" ]; then
+		exp_src_dirs=$(sed 's/,/ /g' <<< ${OTHERSRCDIRS})
+		find ${exp_src_dirs} ${ignore} ${find_def_params};
+	else
+		find ${tree}* ${ignore} \
+		     \( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) \
+		     -prune -o ${find_def_params};
+	fi
 }

 find_sources()
-- 
2.38.1