From: David Marchand <david.marchand@redhat.com>
To: Bruce Richardson <bruce.richardson@intel.com>,
Thomas Monjalon <thomas@monjalon.net>
Cc: dev@dpdk.org, jerinjacobk@gmail.com
Subject: Re: [PATCH v2] doc: build manpages as well as html output
Date: Thu, 3 Aug 2023 11:18:09 +0200 [thread overview]
Message-ID: <CAJFAV8xeiD_0SCsTcO-0AkrW29LsqdRxBL1Yh+zZmzq3W_9Vuw@mail.gmail.com> (raw)
In-Reply-To: <ZLUhWgQiDF0vteYX@bricha3-MOBL.ger.corp.intel.com>
On Mon, Jul 17, 2023 at 1:09 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
> > There may be some polishing to do later.
> > Looking at the result for rte_eal_init, I see that the generated
> > manual starts with a reference to the rte_eal.h header with a path
> > relative to its location in the DPDK tree.
> > $ MANPATH=build-gcc/install/share/man man rte_eal_init | head -5
> > lib/eal/include/rte_eal.h(3)
> > DPDK
> >
> > lib/eal/include/rte_eal.h(3)
> >
> > NAME
> > lib/eal/include/rte_eal.h
> >
> > At least, it is possible to ask for this header man with "man
> > rte_eal.h", but it is a bit confusing.
> > Is there something we can do on this side?
> >
>
> Not sure, not really familiar with how doxygen works generating manpages
> and the options supported, etc. etc. Mainly I just looked at the
> build-system side to support this, since I really missed having manpages
> for DPDK functions to quickly check parameter order.
doxygen is invoked on the sources tree, so this is probably the reason
why such path is in the generated manual.
Maybe Thomas has an idea how we could handle this.
In any case, I am fine with this patch as it is now.
--
David Marchand
next prev parent reply other threads:[~2023-08-03 9:18 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-01 15:38 [PATCH] " Bruce Richardson
2023-06-05 5:20 ` Jerin Jacob
2023-06-06 9:18 ` Bruce Richardson
2023-06-06 9:46 ` Jerin Jacob
2023-06-06 10:18 ` Bruce Richardson
2023-06-06 10:49 ` Jerin Jacob
2023-06-06 10:54 ` Bruce Richardson
2023-06-06 13:12 ` [PATCH v2] " Bruce Richardson
2023-07-04 8:21 ` David Marchand
2023-07-17 11:09 ` Bruce Richardson
2023-08-03 9:18 ` David Marchand [this message]
2023-08-03 16:43 ` Bruce Richardson
2023-08-03 16:44 ` [PATCH v3] " Bruce Richardson
2023-08-04 12:12 ` David Marchand
2023-08-29 9:28 ` Thomas Monjalon
2023-08-29 10:10 ` Bruce Richardson
2023-08-30 9:47 ` Thomas Monjalon
2023-08-30 10:20 ` Bruce Richardson
2023-08-30 11:23 ` Thomas Monjalon
2023-08-31 9:49 ` [PATCH v4] " Bruce Richardson
2023-08-31 10:12 ` Thomas Monjalon
2023-08-31 15:48 ` Morten Brørup
2023-09-27 16:25 ` Thomas Monjalon
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=CAJFAV8xeiD_0SCsTcO-0AkrW29LsqdRxBL1Yh+zZmzq3W_9Vuw@mail.gmail.com \
--to=david.marchand@redhat.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=jerinjacobk@gmail.com \
--cc=thomas@monjalon.net \
/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).