From: Paul Szczepanek <paul.szczepanek@arm.com>
To: dev@dpdk.org
Cc: probb@iol.unh.edu, Paul Szczepanek <paul.szczepanek@arm.com>
Subject: [PATCH] dts: fix doxygen API link
Date: Wed, 23 Oct 2024 15:57:32 +0100 [thread overview]
Message-ID: <20241023145732.286071-1-paul.szczepanek@arm.com> (raw)
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 <paul.szczepanek@arm.com>
Acked-by: Patrick Robb <probb@iol.unh.edu>
---
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 != 0
subdir_done()
endif
-cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html'))
-
extra_sphinx_args = ['-E', '-c', join_paths(doc_source_dir, 'guides')]
if get_option('werror')
extra_sphinx_args += '-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(dpdk_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
--
2.39.2
next reply other threads:[~2024-10-23 14:58 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-23 14:57 Paul Szczepanek [this message]
2024-10-23 15:00 ` Luca Vizzarro
2024-10-23 15:07 ` David Marchand
2024-10-23 15:10 ` Patrick Robb
2024-10-23 15:30 ` David Marchand
2024-10-24 9:12 ` David Marchand
2024-10-24 17:45 ` Paul Szczepanek
2024-10-25 10:35 ` [PATCH v2] dts: fix doxygen API link and DTS docs placement Paul Szczepanek
2024-10-28 18:56 ` Dean Marx
2024-11-06 20:14 ` Nicholas Pratte
2024-11-07 13:54 ` Patrick Robb
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20241023145732.286071-1-paul.szczepanek@arm.com \
--to=paul.szczepanek@arm.com \
--cc=dev@dpdk.org \
--cc=probb@iol.unh.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).