From: Marat Khalili <marat.khalili@huawei.com>
To: "dev@dpdk.org" <dev@dpdk.org>
Subject: [RFC] doc: updating doxy-api-index.md and doxy-api.conf.in
Date: Tue, 30 Jun 2026 09:03:03 +0000 [thread overview]
Message-ID: <f0e4ffa90e57467cb292d7888caa697e@huawei.com> (raw)
I noticed that a few header files contain docstring-like comments but are not
present in doc/api/doxy-api-index.md and/or (fewer) in doc/api/doxy-api.conf.in
There seem to be no checks anywhere in the process that would make sure these
index files are updated. Do we even care, or is it unsupported legacy? If we do
care, would a check or an automatic generation fix be more promising?
With Best Regards,
Marat
next reply other threads:[~2026-06-30 9:03 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-06-30 9:03 Marat Khalili [this message]
2026-06-30 16:10 ` [RFC] doc: updating doxy-api-index.md and doxy-api.conf.in Thomas Monjalon
2026-06-30 16:45 ` Bruce Richardson
2026-07-02 20:00 ` [PATCH 0/7] doc: build for all public headers Marat Khalili
2026-07-02 20:00 ` [PATCH 1/7] doc: detect ignored " Marat Khalili
2026-07-02 20:00 ` [PATCH 2/7] doc: document rte_os.h Marat Khalili
2026-07-02 20:00 ` [PATCH 3/7] doc: fix typos in rte_bus_pci.h Marat Khalili
2026-07-02 20:00 ` [PATCH 4/7] doc: fix typos in rte_bus_vmbus.h Marat Khalili
2026-07-02 20:00 ` [PATCH 5/7] doc: add missing globs to doxy-api.conf.in Marat Khalili
2026-07-02 20:00 ` [PATCH 6/7] doc: add missing drivers " Marat Khalili
2026-07-02 20:00 ` [PATCH 7/7] doc: add missing headers to doxy-api-index.md Marat Khalili
2026-07-06 10:52 ` [PATCH v2 0/7] doc: build for all public headers Marat Khalili
2026-07-06 10:52 ` [PATCH v2 1/7] doc: detect ignored " Marat Khalili
2026-07-06 10:52 ` [PATCH v2 2/7] doc: document rte_os.h Marat Khalili
2026-07-06 10:52 ` [PATCH v2 3/7] doc: fix typos in rte_bus_pci.h Marat Khalili
2026-07-06 10:52 ` [PATCH v2 4/7] doc: fix typos in rte_bus_vmbus.h Marat Khalili
2026-07-06 10:52 ` [PATCH v2 5/7] doc: add missing globs to doxy-api.conf.in Marat Khalili
2026-07-06 10:52 ` [PATCH v2 6/7] doc: add missing drivers " Marat Khalili
2026-07-06 10:52 ` [PATCH v2 7/7] doc: add missing headers to doxy-api-index.md Marat Khalili
2026-07-06 13:14 ` [PATCH v2 0/7] doc: build for all public headers Marat Khalili
2026-07-07 8:50 ` [PATCH v3 0/8] " Marat Khalili
2026-07-07 8:50 ` [PATCH v3 1/8] doc: detect ignored " Marat Khalili
2026-07-07 8:50 ` [PATCH v3 2/8] doc: document rte_os.h Marat Khalili
2026-07-07 8:50 ` [PATCH v3 3/8] doc: fix typos in rte_avp_common.h Marat Khalili
2026-07-07 8:50 ` [PATCH v3 4/8] doc: fix typos in rte_bus_pci.h Marat Khalili
2026-07-07 8:50 ` [PATCH v3 5/8] doc: fix typos in rte_bus_vmbus.h Marat Khalili
2026-07-07 8:50 ` [PATCH v3 6/8] doc: add missing globs to doxy-api.conf.in Marat Khalili
2026-07-07 8:50 ` [PATCH v3 7/8] doc: add missing drivers " Marat Khalili
2026-07-07 8:50 ` [PATCH v3 8/8] doc: add missing headers to doxy-api-index.md Marat Khalili
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=f0e4ffa90e57467cb292d7888caa697e@huawei.com \
--to=marat.khalili@huawei.com \
--cc=dev@dpdk.org \
/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