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 7146B45BC0; Thu, 24 Oct 2024 11:13:06 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0C1DB43396; Thu, 24 Oct 2024 11:13:06 +0200 (CEST) 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 C1B454003C for ; Thu, 24 Oct 2024 11:13:04 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1729761184; 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: in-reply-to:in-reply-to:references:references; bh=yCAYxPcp1LtKiNZFyRRcDFLBPra5hNtMgPJipjibMPA=; b=HkFbW1QZJk4BDXgWEPJHT+tQzOLUwV0yt5lXALTKWyODgj2+HLZXHiPyL9887c9ZimJ1di aVMgTiXO4Wye++k7afdwU0bjOYhcdiBHsylSYOr8V5oAuBRl5O/DSgPzFPMjwImL/tof6L /YgUEiEawwlcncRwR8WkdI0K6AJvk10= Received: from mail-lj1-f199.google.com (mail-lj1-f199.google.com [209.85.208.199]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-54-PQjWz0JpN8umXhVfMILrZw-1; Thu, 24 Oct 2024 05:13:02 -0400 X-MC-Unique: PQjWz0JpN8umXhVfMILrZw-1 Received: by mail-lj1-f199.google.com with SMTP id 38308e7fff4ca-2fb58980614so4352691fa.2 for ; Thu, 24 Oct 2024 02:13:02 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729761181; x=1730365981; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=yCAYxPcp1LtKiNZFyRRcDFLBPra5hNtMgPJipjibMPA=; b=UA6U9X5FoS32tOW2JgeBS/gaMq2VSmrktV99Q+6Ifapg1X9M0vSX3enKGwmaeKCIu6 wBEkNlNQOSLKUOmrwLKYAJBTDzjqB3sesgqgiZrr7D32uC67jGKmlmegDFMWr0MkB7Ph PwEnYORfG7RXhxS0hN+Bzyl/2uhClN4Ox4XgAMW08Yj/Y62T98+L7fNksKRH9hHQTIRe M4bgPFoNQJz4oSlB3ErWrwe9JKJVOpUf9vMo41CE1NgnODgV6t8UL2HX81NR9fjzW9Mp rpss2kgQXL3X1drwWpRIt0yQlmhwfnMygpZCzoS7DIl249ooMysAsesUcRecHBjseiHK cECQ== X-Gm-Message-State: AOJu0Yz8qS0TUUhAF5NOv4s3EHg8H9D09T4b1RKLyHi+yhHVLNAWURKy sDxeFJOWglk6uBxwkPRtee3f+vuvifqEHg5oU2tbFghBP0KpLwgG7x8BMBhRrkEtReGvw1x++uj 91FZiwJbFH5PC/x9E7e1kbKgynnjYR3z9WPYRPnH8V2ZbNNojXl/+agBBCv41h0iXxPwbcLaXMN KEq7E5rJf58e3xwDY= X-Received: by 2002:a05:6512:318c:b0:539:9490:7257 with SMTP id 2adb3069b0e04-53b1a3404f6mr3102110e87.30.1729761181315; Thu, 24 Oct 2024 02:13:01 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGG1wzY5D1J8F8lewTYQTUFjBHGmEQuob8eH19UwXLpKCogvRCHqb0C6fxb21hk2NQEECqkImxYBH+4RNv8HKs= X-Received: by 2002:a05:6512:318c:b0:539:9490:7257 with SMTP id 2adb3069b0e04-53b1a3404f6mr3102092e87.30.1729761180840; Thu, 24 Oct 2024 02:13:00 -0700 (PDT) MIME-Version: 1.0 References: <20241023145732.286071-1-paul.szczepanek@arm.com> In-Reply-To: From: David Marchand Date: Thu, 24 Oct 2024 11:12:50 +0200 Message-ID: Subject: Re: [PATCH] dts: fix doxygen API link To: Paul Szczepanek , probb@iol.unh.edu Cc: dev@dpdk.org, Luca Vizzarro , Thomas Monjalon X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Wed, Oct 23, 2024 at 5:30=E2=80=AFPM David Marchand wrote: > > On Wed, Oct 23, 2024 at 4:58=E2=80=AFPM Paul Szczepanek wrote: > > > > Alias used to produce the link to the DTS API docs uses config data. > > The required value in config data was being added in the wrong scope. > > This moves the key addition to where the config data object is created. > > > > Fixes: 7f9326423a04 ("dts: add API doc generation") > > > > Signed-off-by: Paul Szczepanek > > Acked-by: Patrick Robb > > --- > > doc/api/dts/meson.build | 2 -- > > doc/api/meson.build | 1 + > > 2 files changed, 1 insertion(+), 2 deletions(-) > > > > diff --git a/doc/api/dts/meson.build b/doc/api/dts/meson.build > > index 5115df7095..5cb4a68dd4 100644 > > --- a/doc/api/dts/meson.build > > +++ b/doc/api/dts/meson.build > > @@ -11,8 +11,6 @@ if python_ver_satisfied !=3D 0 > > subdir_done() > > endif > > > > -cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.= html')) > > - > > extra_sphinx_args =3D ['-E', '-c', join_paths(doc_source_dir, 'guides'= )] > > if get_option('werror') > > extra_sphinx_args +=3D '-W' > > diff --git a/doc/api/meson.build b/doc/api/meson.build > > index ae23e9825e..fdb04e0ec8 100644 > > --- a/doc/api/meson.build > > +++ b/doc/api/meson.build > > @@ -40,6 +40,7 @@ cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc'= , 'api')) > > cdata.set('TOPDIR', dpdk_source_root) > > cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dp= dk_build_root, 'doc', 'api')])) > > cdata.set('WARN_AS_ERROR', 'NO') > > +cdata.set('DTS_API_MAIN_PAGE', join_paths(dpdk_build_root, 'doc', 'api= ', 'dts', 'html', 'index.html')) > > if get_option('werror') > > cdata.set('WARN_AS_ERROR', 'YES') > > endif > > Looking again while applying, something is fishy in doc/api/meson.build: > > if not doxygen.found() > # process DTS API doc build even if DPDK API doc build can't be done > cdata =3D configuration_data() > subdir('dts') > subdir_done() > endif > > Should this cdata (unused afaics) object be removed too? It seems there are more issues with the doc generation. Looking at dpdk.org documentation (https://doc.dpdk.org/api/), there is a dead link to DTS at the bottom of the page: tests: [DTS]() The documentation for dts should be generated to dpdk_build_root /doc/api/html/dts And I think the link should be a relative one, like cdata.set('DTS_API_MAIN_PAGE', join_paths('dts', 'index.html')) Please have a look. --=20 David Marchand