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 EEADCA0C52 for ; Tue, 23 Nov 2021 16:16:55 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DF309410E5; Tue, 23 Nov 2021 16:16:55 +0100 (CET) Received: from mail-wr1-f41.google.com (mail-wr1-f41.google.com [209.85.221.41]) by mails.dpdk.org (Postfix) with ESMTP id A264A4003C; Tue, 23 Nov 2021 16:16:53 +0100 (CET) Received: by mail-wr1-f41.google.com with SMTP id a9so39542720wrr.8; Tue, 23 Nov 2021 07:16:53 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:subject:from:to:cc:date:in-reply-to :references:content-transfer-encoding:user-agent:mime-version; bh=EAR4Mxhhb37sFzkVQFDXxWKQpa8wlvJUw2v8CVCOSa4=; b=cSFpRc5s81lGdGAs9ZLvuVg28x0qzA99+zQ6ScKfbUfX5ifswAtVwL/MD0LRjKFUhy XjpNAFDBuimpcLGsQFQiTK7uEtx9Ce2s3mQcQQoV5sd0I2yfSttozDU5BjBUsOrax5UR YVueJvtPeKF8UkfflqF79tzXXWrjPeUI8CO8uxnMJZYzDXn5Xk3zYNAORuetYlG3WegM gocoGO77mdM7fRZrPonLa/lhoF/q/yfNyH4B5W5DIFwId9FOYOS+1KMGzgdfdjOFzvDg z/iPwWSWZZ+vuBWgMU6XG8Zl2u4OuHrT8H8qJk37YOMku8g6EC7Gym9HUn3KL2o1vBvJ t/tw== X-Gm-Message-State: AOAM531YW925fk7xfFnNlRcdJAKnMYhh1gEX6/9bEiycVqrXbSAJLvFO sethVxzYKD1+TE4wUjZrpyXiZQQrDeXSkw== X-Google-Smtp-Source: ABdhPJwXZdxOtQHdKpMo1mxJVb/yPR5LED+hvbY+3uftR7JPbyuatYZvodwRJRGbMqI1uqu6r/Lbxg== X-Received: by 2002:a5d:548b:: with SMTP id h11mr4678153wrv.200.1637680613223; Tue, 23 Nov 2021 07:16:53 -0800 (PST) Received: from localhost ([137.220.125.106]) by smtp.gmail.com with ESMTPSA id o12sm1835114wmq.12.2021.11.23.07.16.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Nov 2021 07:16:52 -0800 (PST) Message-ID: <5e15eb1533ce8043f2cdaf3c7cd43463e513f393.camel@debian.org> Subject: Re: [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH From: Luca Boccassi To: Timothy Redaelli , Ferruh Yigit , Thomas Monjalon Cc: dev@dpdk.org, stable@dpdk.org Date: Tue, 23 Nov 2021 15:16:52 +0000 In-Reply-To: <4c058c558a858267b8d14b0460dce5fcc8bbcc2c.1637678260.git.tredaelli@redhat.com> References: <4c058c558a858267b8d14b0460dce5fcc8bbcc2c.1637678260.git.tredaelli@redhat.com> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable User-Agent: Evolution 3.38.3-1+plugin MIME-Version: 1.0 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 On Tue, 2021-11-23 at 15:48 +0100, Timothy Redaelli wrote: > 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. >=20 > 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. >=20 > Fixes: a6090630f4e5 ("doc: automate examples file list for API") > Cc: ferruh.yigit@intel.com > Cc: stable@dpdk.org > Signed-off-by: Timothy Redaelli > --- > v2: > =C2=A0- Don't use another VARIABLE name, but set STRIP_FROM_PATH with the= 2 > =C2=A0=C2=A0=C2=A0paths directly (suggested by David Marchand) > =C2=A0- Strip the full path of examples.dox (except the last component) > =C2=A0=C2=A0=C2=A0instead of stripping only build_root. This is needed si= nce doxygen > =C2=A0=C2=A0=C2=A0generates the HASH of dir_HASH.html filename using the = last component > =C2=A0=C2=A0=C2=A0of the path and so if the last part of buildroot is cha= nged, the > =C2=A0=C2=A0=C2=A0filename is different. > --- > =C2=A0doc/api/meson.build | 2 +- > =C2=A01 file changed, 1 insertion(+), 1 deletion(-) >=20 > 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 > =C2=A0cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api')) > =C2=A0cdata.set('HTML_OUTPUT', 'html') > =C2=A0cdata.set('TOPDIR', meson.source_root()) > -cdata.set('STRIP_FROM_PATH', meson.source_root()) > +cdata.set('STRIP_FROM_PATH', ' '.join([meson.source_root(), join_paths(m= eson.build_root(), 'doc', 'api')])) > =C2=A0cdata.set('WARN_AS_ERROR', 'NO') > =C2=A0if get_option('werror') > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0cdata.set('WARN_AS_ERROR', 'YES') Acked-by: Luca Boccassi --=20 Kind regards, Luca Boccassi