From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>,
"Hunt, David" <david.hunt@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>,
"Kovacevic, Marko" <marko.kovacevic@intel.com>
Subject: Re: [dpdk-dev] [PATCH] doc/power: fix references in power management
Date: Fri, 18 Jan 2019 12:15:45 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23F507841@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1919587.yrck2HIdBR@xps>
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, January 17, 2019 6:51 PM
> To: Hunt, David <david.hunt@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic,
> Marko <marko.kovacevic@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] doc/power: fix references in power
> management
> ...
> > -* The "L3 Forwarding with Power Management Sample Application"
> chapter in the *DPDK Sample Application's User Guide*.
> > +* The :doc:`VM Power Management
> Application<../sample_app_ug/vm_power_management>`
> > + chapter in the :doc:`Sample Applications User
> Guides<../sample_app_ug/index>` section.
>
> These are complex references. You don't need to specifiy the title, it is
> automatically generated.
>
> Marko, please take care of not making the doc more complex in your
> review.
> In your patch "doc: add new introduction to sample app guides", you did
> the same as above.
For what it is worth this syntax is fine by me and quite commonly used in
Python documentation.
However, in this particular case it is unnecessary since the doc: title and the
override title are the same. It is only worth using this syntax if you want a
different title in the inline text.
John
next prev parent reply other threads:[~2019-01-18 12:15 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-15 13:38 David Hunt
2019-01-17 10:50 ` Kovacevic, Marko
2019-01-17 18:51 ` Thomas Monjalon
2019-01-18 12:15 ` Mcnamara, John [this message]
2019-01-18 14:31 ` Thomas Monjalon
2019-01-18 9:34 ` [dpdk-dev] [PATCH v2] doc: fix references in power management guide David Hunt
2019-01-20 12:26 ` Thomas Monjalon
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=B27915DBBA3421428155699D51E4CFE23F507841@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=david.hunt@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).