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 B138F454E2; Mon, 24 Jun 2024 16:08:09 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A3CE94065B; Mon, 24 Jun 2024 16:08:09 +0200 (CEST) Received: from mail-ej1-f43.google.com (mail-ej1-f43.google.com [209.85.218.43]) by mails.dpdk.org (Postfix) with ESMTP id A78A8402F0 for ; Mon, 24 Jun 2024 16:08:07 +0200 (CEST) Received: by mail-ej1-f43.google.com with SMTP id a640c23a62f3a-a72517e6225so142755266b.0 for ; Mon, 24 Jun 2024 07:08:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1719238087; x=1719842887; darn=dpdk.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=lbUD/I3ja9DfNoeCLaWEv2y/h7q0Il3vl+0vehzzDeg=; b=n5civnFUDVpJmS38nF1urAKgWLVEXDZoJR70JB5328OIfRRJDPCeA4uh2KKcZoagtC 3xU99yD29AT0kDdIeTUir5dyhEnHcpS6XvjQfsMtmdwxmd7xFuA/petyCdGU02wWNlou y07tlkqYmHlRMNG6MtCq1vLWg6ozn1YH+oenkmuPXUcLU/9gKkAVhL1z19gPu1zZv/Cn /wvvPt9/xTzNAZaLLRua4ss3xyDK0CA/n1HPtTl8JsC+7X8MklGmbOo82rKB2nt6iwT7 Is6DgOdMUfUG61okgna1UUw3o2TlCsmjavJqi8UJvfYRMhVOUqqw2J0DWNx/mom3ixk/ tS4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719238087; x=1719842887; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=lbUD/I3ja9DfNoeCLaWEv2y/h7q0Il3vl+0vehzzDeg=; b=uArBCgPIzFt5KqxqcKoiSgKk3GhVpeNUBLJQQGdvDFWkd7NtQ7dHxkdMuyIRytzVoY on+ya+5hvWCdhNoWmS9vSpfbVH/syHit3Ld7XECpcD4m8MgZIXntgT61toywoNOK0H3l 4rDeZDgAaX7VEalWTOuhsbMlPRKvrE88HiOwMwQj/Xk61I26TPCFg4d7ziYAsB9cte/6 2xApchpNviulHkhzwEQOaegRCjq+8+rr/1iKNeo4jgmbZGeHQH2rgfAlJgz8rhey7V1E H1K3fTbxCPt5DwbO9Vr+VzzIxdxtxgvV/4prI7hPqRHr9MyySh5b9eEU6b8RUJEYXuQc 9wow== X-Gm-Message-State: AOJu0Ywi+cZn3UPcMR6ihh6d8ep5Rhn3T7KocVdztXaJjBWIjt6K1KJ8 cgt3/RFMNnyYZGG/WWTcw/0Gb9EE0ui0+VxBgXNTsrPzsVBxRpZ2bdLu9dU4HdQ= X-Google-Smtp-Source: AGHT+IHKzVbTomXowlejJi7miyTmlEiwp7PfxWR3p2xDKNFpGNff6P/+H1WMY/1Hq0YAM0E97YZkmA== X-Received: by 2002:a17:907:c5c7:b0:a6f:b8b0:ae19 with SMTP id a640c23a62f3a-a715f978748mr365718666b.36.1719238087148; Mon, 24 Jun 2024 07:08:07 -0700 (PDT) Received: from [192.168.1.113] ([84.245.121.236]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a6fcf48b51csm414308566b.89.2024.06.24.07.08.06 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 24 Jun 2024 07:08:06 -0700 (PDT) Message-ID: <1a95f3c6-5b9c-4bc0-8cdd-dbd1f998288c@pantheon.tech> Date: Mon, 24 Jun 2024 16:08:05 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v6 4/4] dts: add API doc generation To: thomas@monjalon.net Cc: dev@dpdk.org, Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240624134600.31500-1-juraj.linkes@pantheon.tech> <20240624134600.31500-5-juraj.linkes@pantheon.tech> Content-Language: en-US From: =?UTF-8?Q?Juraj_Linke=C5=A1?= In-Reply-To: <20240624134600.31500-5-juraj.linkes@pantheon.tech> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit 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 Hi Thomas, I believe the only open question in this patch set is the linking of DTS API docs on the main doxygen page. I've left only the parts relevant to the question so that it's easier for us to address it. > diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md > index f9283154f8..cc214ede46 100644 > --- a/doc/api/doxy-api-index.md > +++ b/doc/api/doxy-api-index.md > @@ -244,3 +244,6 @@ The public API headers are grouped by topics: > [experimental APIs](@ref rte_compat.h), > [ABI versioning](@ref rte_function_versioning.h), > [version](@ref rte_version.h) > + > +- **tests**: > + [**DTS**](@dts_api_main_page) > diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in > index a8823c046f..c94f02d411 100644 > --- a/doc/api/doxy-api.conf.in > +++ b/doc/api/doxy-api.conf.in > @@ -124,6 +124,8 @@ SEARCHENGINE = YES > SORT_MEMBER_DOCS = NO > SOURCE_BROWSER = YES > > +ALIASES = "dts_api_main_page=@DTS_API_MAIN_PAGE@" > + > EXAMPLE_PATH = @TOPDIR@/examples > EXAMPLE_PATTERNS = *.c > EXAMPLE_RECURSIVE = YES > diff --git a/doc/api/meson.build b/doc/api/meson.build > index 5b50692df9..ffc75d7b5a 100644 > --- a/doc/api/meson.build > +++ b/doc/api/meson.build > @@ -32,14 +33,18 @@ example = custom_target('examples.dox', > # set up common Doxygen configuration > cdata = configuration_data() > cdata.set('VERSION', meson.project_version()) > -cdata.set('API_EXAMPLES', join_paths(dpdk_build_root, 'doc', 'api', 'examples.dox')) > -cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc', 'api')) > +cdata.set('API_EXAMPLES', join_paths(doc_api_build_dir, 'examples.dox')) > +cdata.set('OUTPUT', doc_api_build_dir) > cdata.set('TOPDIR', dpdk_source_root) > -cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dpdk_build_root, 'doc', 'api')])) > +cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, doc_api_build_dir])) These three changes are here only for context, they're not relevant to the linking question. > cdata.set('WARN_AS_ERROR', 'NO') > if get_option('werror') > cdata.set('WARN_AS_ERROR', 'YES') > endif > +# A local reference must be relative to the main index.html page > +# The path below can't be taken from the DTS meson file as that would > +# require recursive subdir traversal (doc, dts, then doc again) > +cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html')) This is where the path is actually set.