[dpdk-dev] [PATCH] doc/power: fix references in power management
Thomas Monjalon
thomas at monjalon.net
Fri Jan 18 15:31:52 CET 2019
18/01/2019 13:15, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas at monjalon.net]
> > ...
> > > -* 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.
Yes, this is what I meant.
More information about the dev
mailing list