From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1A48DA0C4C for ; Tue, 23 Nov 2021 15:48:55 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id F105B4003C; Tue, 23 Nov 2021 15:48:54 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id BF0834003C for ; Tue, 23 Nov 2021 15:48:53 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1637678933; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=DhRtj4DoEOzvOnKm2L5OstUqTKfHJzf0jbt/lnuL45A=; b=iRBJtW52BilDjO/JzMCd0/IGpKH/MuY473yUfV1w7sFC/lOI89uCVpqAYGDx4bSIVY9ZC0 yZbNBkx470Pd4m/n9VbUGuszda4UMblk3HGLSFGpDAfKK0rqd4M3LA8pbyigPfwVmcTkx6 LmjP8HqhoMJUjcqP5dygyuR/YbC9Bh8= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-322-Eo0-UsVZNlCaFlI3RwoUTQ-1; Tue, 23 Nov 2021 09:48:50 -0500 X-MC-Unique: Eo0-UsVZNlCaFlI3RwoUTQ-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 0BB7D180FCB8; Tue, 23 Nov 2021 14:48:49 +0000 (UTC) Received: from aldebaran.redhat.com (unknown [10.39.195.155]) by smtp.corp.redhat.com (Postfix) with ESMTP id A7D185D6CF; Tue, 23 Nov 2021 14:48:47 +0000 (UTC) From: Timothy Redaelli To: Ferruh Yigit , Thomas Monjalon Cc: Luca Boccassi , dev@dpdk.org, stable@dpdk.org Subject: [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH Date: Tue, 23 Nov 2021 15:48:42 +0100 Message-ID: <4c058c558a858267b8d14b0460dce5fcc8bbcc2c.1637678260.git.tredaelli@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=tredaelli@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Message-ID: <20211123144842.KT0Z3SXgfs4JeR9S-zPwQvMykgrTRAh2bEluWPpMC-k@z> examples.dox is built inside builddir/doc/api and so doxygen generates some dir_HASH.html that includes the builddir name and this may prevent DPDK documentation to be correctly generated in some distributions, for example CentOS Stream 9 and RHEL9, since the builddir includes the architecture. This commit adds builddir/doc/api (the path where examples.dox is generated) to STRIP_FROM_PATH, so the generated documentation doesn't change if builddir changes. Fixes: a6090630f4e5 ("doc: automate examples file list for API") Cc: ferruh.yigit@intel.com Cc: stable@dpdk.org Signed-off-by: Timothy Redaelli --- v2: - Don't use another VARIABLE name, but set STRIP_FROM_PATH with the 2 paths directly (suggested by David Marchand) - Strip the full path of examples.dox (except the last component) instead of stripping only build_root. This is needed since doxygen generates the HASH of dir_HASH.html filename using the last component of the path and so if the last part of buildroot is changed, the filename is different. --- doc/api/meson.build | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/meson.build b/doc/api/meson.build index d34c383694..7e2b429ac8 100644 --- a/doc/api/meson.build +++ b/doc/api/meson.build @@ -36,7 +36,7 @@ cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api')) cdata.set('HTML_OUTPUT', 'html') cdata.set('TOPDIR', meson.source_root()) -cdata.set('STRIP_FROM_PATH', meson.source_root()) +cdata.set('STRIP_FROM_PATH', ' '.join([meson.source_root(), join_paths(meson.build_root(), 'doc', 'api')])) cdata.set('WARN_AS_ERROR', 'NO') if get_option('werror') cdata.set('WARN_AS_ERROR', 'YES') -- 2.33.1