From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: Matthew Hall <mhall@mhcomputing.net>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] Previous DPDK version API documentation for app developers
Date: Thu, 12 Feb 2015 10:29:12 +0100 [thread overview]
Message-ID: <25886713.7gVMi5Gd1P@xps13> (raw)
In-Reply-To: <20150212070635.GA31227@mhcomputing.net>
Hi Matthew,
2015-02-11 23:06, Matthew Hall:
> Hi all,
>
> I ran into a funny situation today with the API documentation.
>
> For stability until I can get my app mostly working, I was using DPDK 1.7.X,
> so I could concentrate on making the app reliable. But the DPDK website only
> has the API docs for DPDK 1.8.X / HEAD.
Yes, previous policy was to publish only the doc of latest release.
But starting with 1.8 (first release including guides), we'll keep every versions.
Example:
http://dpdk.org/doc/api
http://dpdk.org/doc/api-1.8
The web page will be modified to list different versions.
> I was wondering if we could have copies of the most recent few versions in the
> site, and some scripts or steps to regenerate locally so you can get the
> matching version in the local machine.
Yes you can: make doc
For doxygen API only: make doc-api-html
For sphinx only: doc-guides-html.
> This would also help me to do some suppoert things for our community, like
> making small patches to fix parts of the docs with typos / formatting bugs.
>
> With the steps how to generate them right, I could fix docs bugs in the
> sources and make sure the docs read right afterward for others.
Thanks
next prev parent reply other threads:[~2015-02-12 9:29 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-02-12 7:06 Matthew Hall
2015-02-12 9:03 ` Panu Matilainen
2015-02-12 9:39 ` Thomas Monjalon
2015-02-12 9:55 ` Panu Matilainen
2015-02-12 9:29 ` Thomas Monjalon [this message]
2015-02-17 8:48 ` Matthew Hall
2015-02-17 9:30 ` Thomas Monjalon
2015-02-17 9:33 ` Matthew Hall
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=25886713.7gVMi5Gd1P@xps13 \
--to=thomas.monjalon@6wind.com \
--cc=dev@dpdk.org \
--cc=mhall@mhcomputing.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).