From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>,
"Kovacevic, Marko" <marko.kovacevic@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v9 1/2] doc: add generic compilation doc for all sample apps
Date: Wed, 25 Oct 2017 14:32:39 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EDE6183@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1666015.7Vdc7jZGnZ@xps>
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Wednesday, October 25, 2017 11:27 AM
> To: Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>; Herakliusz
> Lipiec <herakliusz.lipiec@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v9 1/2] doc: add generic compilation doc
> for all sample apps
>
> 19/10/2017 14:11, Marko Kovacevic:
> > +.. _sample_app_compilation:
> > +
> > +Compiling the Sample Applications
> > +=================================
>
> I think we should stop adding useless anchors.
> I may be wrong but I don't see the benefit of
> :ref:`sample_app_compilation`
> compared to
> :doc:`compiling`
There is an advantage when the referred to section isn't the first section in the docs:
"Using ref is advised over standard reStructuredText links to sections (like `Section title`_)
because it works across files, when section headings are changed, and for all builders
that support cross-references."
http://www.sphinx-doc.org/en/stable/markup/inline.html#cross-referencing-anything
However, that isn't the case here. So it would be better to use :doc:.
John
prev parent reply other threads:[~2017-10-25 14:35 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-19 12:11 Marko Kovacevic
2017-10-19 12:11 ` [dpdk-dev] [PATCH v9 2/2] doc: add new introduction to sample app guides Marko Kovacevic
2017-10-20 10:32 ` Mcnamara, John
2017-10-20 10:31 ` [dpdk-dev] [PATCH v9 1/2] doc: add generic compilation doc for all sample apps Mcnamara, John
2017-10-25 10:26 ` Thomas Monjalon
2017-10-25 14:32 ` Mcnamara, John [this message]
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=B27915DBBA3421428155699D51E4CFE23EDE6183@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
--cc=marko.kovacevic@intel.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).