[dpdk-dev] [PATCH] doc/power: fix references in power management

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas at monjalon.net]
> Sent: Thursday, January 17, 2019 6:51 PM
> To: Hunt, David <david.hunt at intel.com>
> Cc: dev at dpdk.org; Mcnamara, John <john.mcnamara at intel.com>; Kovacevic,
> Marko <marko.kovacevic at 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