From patchwork Tue May 9 01:26:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Ahmed S. Darwish" X-Patchwork-Id: 91327 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp2550911vqo; Mon, 8 May 2023 18:32:24 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ5H1ZHkCTlos4iOm9tDwV7fRApXlBQYsrMrCGaqi9xvdWPHqnApbMRiLoJtwM0U7t6vMC6E X-Received: by 2002:a17:90a:e50d:b0:247:6a31:d59d with SMTP id t13-20020a17090ae50d00b002476a31d59dmr12235498pjy.1.1683595944311; Mon, 08 May 2023 18:32:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1683595944; cv=none; d=google.com; s=arc-20160816; b=eiN8GD+ekCvRd8j3BA1EQ710ku6b0Y240mMmqnhibqy/PVNK1JqyBCH84jR7X9j9P9 tqcFfBpK304GS63pd+BDmmKF6Wz2Q2pLf80w2hByHdunkhSQHn+eyHdgcvj18CYJq23f 1UE1a58egSgTbwif77WMTLvMELxma2Vl6Y87cdmghJ2HpLOCOG7WElQBeqRQwkrJbLfr wMUredgWSlBHbiqp4ZaAI5cxJoSDdAjwees5z0UA5vOUnnZIsC75u4xaWDtg6kw6aHG2 wJivYnYO3putN4Qrj2xOiDNS6mcICdDkvqcq711lJQYSTXn8XpV3TFtWtgu7gFgPL/hw 5L9g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:dkim-signature :dkim-signature:from; bh=uStzLe1tmofW57614nQAyaAY3eSlDqWR3vQxVmQVS1Y=; b=RePxUDPjmV9OTEjo17xU7AmXZ88QkhJ0ZsmFiLELFPfYjJEoXGeKgGt9cLF31kFScH n5VaTeD64jUL8mPFuUu8KxOUhcDe5KuAKKER4ZzX1F6glpfuVdQu0iAYsCY6ZmDS1/y/ HGfjzpAwMyfKU/3BgDFlRqcoX2UhUAn6Lrv6+icu8Jo92kudLWLzWQ5IOY3bA5dcYts4 oqrMxN/B6Gmh6I23RJhqAYsXpfFGgf3GipDYt6G7wpeV5kaFyo6LOB/87HM/S+epISlB +Y6YPTep4prm3CWGMaKml5IpoS+bBkPVaEtzhhdp5tjs7Gg7bPDDVraUayZIdwQAgBVd uHZg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=xWNjFDl1; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=WJiot4UY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id e5-20020a63aa05000000b00528595a1390si302268pgf.588.2023.05.08.18.32.12; Mon, 08 May 2023 18:32:24 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=xWNjFDl1; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=WJiot4UY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233109AbjEIB0s (ORCPT + 99 others); Mon, 8 May 2023 21:26:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60116 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233265AbjEIB0n (ORCPT ); Mon, 8 May 2023 21:26:43 -0400 Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ACAE0903C; Mon, 8 May 2023 18:26:39 -0700 (PDT) From: "Ahmed S. Darwish" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1683595598; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=uStzLe1tmofW57614nQAyaAY3eSlDqWR3vQxVmQVS1Y=; b=xWNjFDl1s1ucegfBKQoncawd3d6If9tExr6i3v7IB0erVNUwt3jWQ6xpT9t2axmBV47Egz Qzzf/6eG0TQWoOSYHLyK98dgGPoWq8ZPdbKnLBF+bFMDkBIgUD80KfV3P4fHDLcVFEmJ1Q HKAZoci+2bpbtZ1iv9kQZ1koL34GE6y4AbhhEK5SRuKp1S60+KjRB4v/8MHrfVlyzt/aOm ewEZc6123SiU/pGCMhBFSqfDRsFxyVECyL0IWFbGbVRWNXoAghfj67OM2jzDVwAQAmoiQ0 hUyDmEWmdirizxsc1O1FFxo+AItwBn1ssPhe+phW2iue7vCxNDt/PUrrF1BIfg== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1683595598; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=uStzLe1tmofW57614nQAyaAY3eSlDqWR3vQxVmQVS1Y=; b=WJiot4UYEtS47knJadY85GFMDZjw4ZAVKGi64k8JHj3oZMySdSuYS/Vb8RZso5Gw1ThPCM 4eHRjiXqk7nTejDw== To: Masahiro Yamada , Nathan Chancellor , Nick Desaulniers , Nicolas Schier Cc: Thomas Gleixner , linux-kbuild@vger.kernel.org, LKML , "Ahmed S. Darwish" Subject: [PATCH v2 1/2] scripts/tags.sh: Resolve gtags empty index generation Date: Tue, 9 May 2023 03:26:15 +0200 Message-Id: <20230509012616.81579-2-darwi@linutronix.de> In-Reply-To: <20230509012616.81579-1-darwi@linutronix.de> References: <20230504201833.202494-1-darwi@linutronix.de> <20230509012616.81579-1-darwi@linutronix.de> MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1765378300728517582?= X-GMAIL-MSGID: =?utf-8?q?1765378300728517582?= gtags considers any file outside of its current working directory "outside the source tree" and refuses to index it. For O= kernel builds, or when "make" is invoked from a directory other then the kernel source tree, gtags ignores the entire kernel source and generates an empty index. Force-set gtags current working directory to the kernel source tree. Due to commit 9da0763bdd82 ("kbuild: Use relative path when building in a subdir of the source tree"), if the kernel build is done in a sub-directory of the kernel source tree, the kernel Makefile will set the kernel's $srctree to ".." for shorter compile-time and run-time warnings. Consequently, the list of files to be indexed will be in the "../*" form, rendering all such paths invalid once gtags switches to the kernel source tree as its current working directory. If gtags indexing is requested and the build directory is not the kernel source tree, index all files in absolute-path form. Note, indexing in absolute-path form will not affect the generated index, as paths in gtags indices are always relative to the gtags "root directory" (as evidenced by "gtags --dump"). Signed-off-by: Ahmed S. Darwish Cc: --- scripts/tags.sh | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/scripts/tags.sh b/scripts/tags.sh index ea31640b2671..3de4b4ebd891 100755 --- a/scripts/tags.sh +++ b/scripts/tags.sh @@ -32,6 +32,14 @@ else tree=${srctree}/ fi + +# gtags(1) refuses to index any file outside of its current working dir. +# If gtags indexing is requested and the build output directory is not +# the kernel source tree, index all files in absolute-path form. +if [ "$1" = "gtags" -a -n "${tree}" ]; then + tree=$(realpath $tree)/ +fi + # Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH if [ "${ALLSOURCE_ARCHS}" = "" ]; then ALLSOURCE_ARCHS=${SRCARCH} @@ -131,7 +139,11 @@ docscope() dogtags() { - all_target_sources | gtags -i -f - + local gtagsoutdir="${PWD}" + local gtagsroot="${tree}" + + [ -z "${gtagsroot}" ] && gtagsroot="." + all_target_sources | gtags -i -C $gtagsroot -f - $gtagsoutdir } # Basic regular expressions with an optional /kind-spec/ for ctags and From patchwork Tue May 9 01:26:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Ahmed S. Darwish" X-Patchwork-Id: 91325 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp2549581vqo; Mon, 8 May 2023 18:29:24 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ7h5kez6rXmKlUZSVfxuYm09T0WDPbnQ8KpmEUNtyCpR+Hy9gAxyXNDSazSS6B2rUrxvfxE X-Received: by 2002:a17:90b:3685:b0:247:9456:6e13 with SMTP id mj5-20020a17090b368500b0024794566e13mr19859352pjb.11.1683595764624; Mon, 08 May 2023 18:29:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1683595764; cv=none; d=google.com; s=arc-20160816; b=vJWfPjUmJ/vB5+DL+E4fBTSnGErYnmbJDZv8I+OBTl82mHg5mZcF3LUGJujGKVp/Tj ZKoLP3WbK8GSCx1y+gr23dQwplWAQmF7VX97G4cFJVmLN0bP1ZnWaapxaeA/JybfrMOq djdv8sBcJN9/qoasCR4puELdsAV8oErArTz9bL9f2eDmYjtXOGIJnDPABuSlW1vrZ5sB 8hKz6rZhqqSWUIJKnaGBzlWBU7XQiDY30wTVwU8KkEX8m9CO633mqRs+helAyH6WWLU4 Prjbi/gubZML70VAkz9Sq3G2oiHTOjw2qwYN3451c0DcZuA04o+7TtEEMAVNnPU6oNFH 7ufg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:dkim-signature :dkim-signature:from; bh=2FpVaM1b9/dK9ZgZzXFPsww04+6hb6vHVJbMLmOixEs=; b=EJLHrewW1L+/rZGfo9HwVRYd+xn4WNjwIXQgrQD0ubYxPcnNDimg/Sc6VS1bYyz0D0 ACn/Uu6EhGe3GnkBWQayX1lBkw5i/BX68rY/vQ0Nb1uZ2p8YQoL4DjW6So6Jq5OzQUZB rVuL5KAJI88UNnzbUZdJL6rDopQ8wjAE9EZpLsnNU2gg6P9vzq3jpvTvtil9ZP2pcz+g MRiCIkgwVSM8X3PRd0qpfq9dnYUgPamGwCDY0DrJ4aF1t+VU5KhgIfkplr2NQCuqZgHH NseJoH8KsvvyIIblkchkT53Oct6yY9g9XszUTB/RzbMFkVM+7anu4008P8QETUlLpgrY fjiQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=ELAtSl2I; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=TZOqOHsO; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id bv5-20020a632e05000000b00513522ea60asi254465pgb.615.2023.05.08.18.29.10; Mon, 08 May 2023 18:29:24 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=ELAtSl2I; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=TZOqOHsO; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229457AbjEIB0v (ORCPT + 99 others); Mon, 8 May 2023 21:26:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60156 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230399AbjEIB0r (ORCPT ); Mon, 8 May 2023 21:26:47 -0400 Received: from galois.linutronix.de (Galois.linutronix.de [IPv6:2a0a:51c0:0:12e:550::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 157D39EF7; Mon, 8 May 2023 18:26:42 -0700 (PDT) From: "Ahmed S. Darwish" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1683595601; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=2FpVaM1b9/dK9ZgZzXFPsww04+6hb6vHVJbMLmOixEs=; b=ELAtSl2IMtdlg7PbfAf2eQ/WCKprqNTcowRfQlQ7OWL3S8e+MqkVf6CzNhYDuHus1MQmdj FLEMJm3W5RzWhgjXVvmC46uQ3fgHjzfQSswQrRRInUPVPcW/pvc7rI4o8sUHDJrSxIbBTQ D8se8nyPbTwAP312nkqooBzp0EJiPsgDSwW7MFolsWYf8rkRuPmmGB3mvg/3fskQRB/1Dr SICdgDP5jYSLYoOAHr8ow+V39j86alQKjsVaDq9aQ9Mbx37B6bf9EObIp8rkQr7c/4dD4Y rdhLKrfos1kg9O9VGxAapKRSqrJRSJqsmQsC7SetWR18jSMmtA5Zts0FHPxW4g== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1683595601; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=2FpVaM1b9/dK9ZgZzXFPsww04+6hb6vHVJbMLmOixEs=; b=TZOqOHsOZHAdVNxm/WWL24EBFkQQ7fhfUJI6BI1Hald7rlOG6X1kk6zqjP0kGymOje/BxE canixfzlL96ppyCg== To: Masahiro Yamada , Nathan Chancellor , Nick Desaulniers , Nicolas Schier Cc: Thomas Gleixner , linux-kbuild@vger.kernel.org, LKML , "Ahmed S. Darwish" Subject: [PATCH v2 2/2] docs: Set minimal gtags / GNU GLOBAL version to 6.6.5 Date: Tue, 9 May 2023 03:26:16 +0200 Message-Id: <20230509012616.81579-3-darwi@linutronix.de> In-Reply-To: <20230509012616.81579-1-darwi@linutronix.de> References: <20230504201833.202494-1-darwi@linutronix.de> <20230509012616.81579-1-darwi@linutronix.de> MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1765378112224244529?= X-GMAIL-MSGID: =?utf-8?q?1765378112224244529?= Kernel build now uses the gtags "-C (--directory)" option, available since GNU GLOBAL v6.6.5. Update the documentation accordingly. Signed-off-by: Ahmed S. Darwish Cc: Link: https://lists.gnu.org/archive/html/info-global/2020-09/msg00000.html --- Documentation/process/changes.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst index ef540865ad22..a9ef00509c9b 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst @@ -60,6 +60,7 @@ openssl & libcrypto 1.0.0 openssl version bc 1.06.95 bc --version Sphinx\ [#f1]_ 1.7 sphinx-build --version cpio any cpio --version +gtags (optional) 6.6.5 gtags --version ====================== =============== ======================================== .. [#f1] Sphinx is needed only to build the Kernel documentation @@ -174,6 +175,12 @@ You will need openssl to build kernels 3.7 and higher if module signing is enabled. You will also need openssl development packages to build kernels 4.3 and higher. +gtags / GNU GLOBAL (optional) +----------------------------- + +The kernel build requires GNU GLOBAL version 6.6.5 or later to generate +tag files through ``make gtags``. This is due to its use of the gtags +``-C (--directory)`` flag. System utilities ****************