From: "Iremonger, Bernard" <bernard.iremonger@intel.com>
To: Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [RFC PATCH 3/4] doc: nics guide
Date: Mon, 2 Feb 2015 17:54:34 +0000 [thread overview]
Message-ID: <8CEF83825BEC744B83065625E567D7C2049DCDB5@IRSMSX108.ger.corp.intel.com> (raw)
In-Reply-To: <1500004.RM7mZx5SlJ@xps13>
> > > > 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.
next prev parent reply other threads:[~2015-02-02 22:05 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-31 23:35 [dpdk-dev] [RFC PATCH 0/4] welcome doc for new nics and environments Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 1/4] doc: fix file attributes Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 2/4] doc: move Xen guide out of programmers guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 3/4] doc: nics guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 4/4] doc: remove copyright footer Thomas Monjalon
[not found] ` <1678582.gq5SofjDC3@xps13>
[not found] ` <8CEF83825BEC744B83065625E567D7C2049DCD83@IRSMSX108.ger.corp.intel.com>
[not found] ` <1500004.RM7mZx5SlJ@xps13>
2015-02-02 17:54 ` Iremonger, Bernard [this message]
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 1/3] doc: fix file attributes Thomas Monjalon
2015-03-19 18:03 ` Butler, Siobhan A
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 2/3] doc: move Xen guide out of programmers guide Thomas Monjalon
2015-03-19 18:03 ` Butler, Siobhan A
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 3/3] doc: nics guide Thomas Monjalon
2015-03-19 17:36 ` Iremonger, Bernard
2015-03-19 18:02 ` Butler, Siobhan A
2015-03-30 23:38 ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-31 11:34 ` Mcnamara, John
2015-03-31 12:23 ` Thomas Monjalon
2015-04-01 9:19 ` Iremonger, Bernard
2015-04-01 16:36 ` Mcnamara, John
2015-04-01 17:20 ` Iremonger, Bernard
2015-04-02 7:59 ` Mcnamara, John
2015-04-02 11:04 ` [dpdk-dev] [RFC] doc: refactored figure numbers into references John McNamara
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=8CEF83825BEC744B83065625E567D7C2049DCDB5@IRSMSX108.ger.corp.intel.com \
--to=bernard.iremonger@intel.com \
--cc=dev@dpdk.org \
--cc=thomas.monjalon@6wind.com \
/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).