[dpdk-dev] [PATCH v3] doc: add graphic showing layout of mbuf struct

[Thomas Monjalon]

Any update?


18/10/2019 12:56, Jerin Jacob:
> On Thu, Oct 17, 2019 at 9:28 PM Olivier Matz <olivier.matz at 6wind.com> wrote:
> >
> > Hi,
> >
> > On Tue, Aug 27, 2019 at 10:02:30AM +0100, A.McLoughlin wrote:
> > > This patch adds a graphical overview of the rte_mbuf struct, showing where
> > > each value is stored within the struct.
> > >
> > > Signed-off-by: A.McLoughlin <aideen.mcloughlin at intel.com>
> > > ---
> > > v1 -> v2:
> > > * changed uint16_t refcnt(+atomic) to uint16_t refcnt
> > > v2 -> v3:
> > > * added layout of extrenally stored struct rte_mbuf sched sched
> > > * added struct names for named structs
> > > * made variable names bold for differenciation from types
> > > * minor styling changes
> > > * specified that graphic represents layout on 64B machine
> > > ---
> > >  doc/guides/prog_guide/img/mbuf_graphic.svg | 6962 ++++++++++++++++++++
> > >  doc/guides/prog_guide/mbuf_lib.rst         |   12 +
> > >  2 files changed, 6974 insertions(+)
> > >  create mode 100644 doc/guides/prog_guide/img/mbuf_graphic.svg
> >
> > The diagram is nice, however we have to be careful because it
> > has to be kept sync with the code. I tried to edit the svg with
> > inkscape, and it seems the text is described as vector shapes,
> > which make the diagram impossible to update.
> >
> > Couldn't it be replaced by the output of pahole? Or better, just explain
> > how to generate it in the documentation? The user can then be sure that
> 
> +1 for explaining how to generate it in the documentation as pahole
> output varies for the 128B cache line machine.
> 
> 
> > the information is up to date, matches its architecture, and can also
> > check structures other than mbuf.