[dpdk-dev] [RFC PATCH 3/4] doc: nics guide

[Iremonger, Bernard]

> > > > It would be better to recreate the references  in  doc/guides/nics/index.rst rather than just
> delete them.
> > > > I don't think there is any need to renumber them.
> > > > The references are global across documents and must be unique.
> > >
> > > No the references are not really uniques:
> > > 	- Figures in doc/guides/sample_app_ug/index.rst start from 1 to 17.
> > > 	- Figures in doc/guides/prog_guide/index.rst start from 1 to 39.
> > > When adding a new new figure in a document, we must renumber them.
> >
> > I had this problem before with duplicate numbers, so in the prog_guide I prefixed the links with
> "pg_" so the links are unique.
> > For example:
> >  :ref:`Figure 16. Memory Sharing inthe Intel(r) DPDK Multi-process
> > Sample Application <pg_figure_16>`
> 
> OK I understand what is unique.
> But I still think that the number in "Figure 16." should be automatically generated.

Hi Thomas,

I looked at this before and I do not think there is a way to automatically generate the number

> > > Are you speaking about the figure references at the bottom of this page?
> > > 	http://dpdk.org/doc/guides/prog_guide
> > > It doesn't really help for browsing.
> >
> > No, what I mean is that within a document you can jump to another section and back for example:
> >
> > file:///home/bairemon/git_home/dpdk_master/build/doc/html/guides/prog_
> > guide/mbuf_lib.html There is link on this page that allows the reader
> > to jump to Mempool Library
> > file:///home/bairemon/git_home/dpdk_master/build/doc/html/guides/prog_
> > guide/mempool_lib.html#mempool-library
> > The reader can use the back arrow in the browser to return to the original page.
> > All of the links are used for this purpose.
> 
> OK, it was a misunderstanding. I agree the cross references are useful.
> I'm speaking only about the Figure/Table list at the bottom of the index.

The references were all gathered here in the original 1.7 MSWord documents.
It also useful for testing the links to have them all in one place.

> 
> --
> Thomas

Regards,

Bernard.