[PATCH] doc/power: fix references in power management

[PATCH] doc/power: fix references in power management

[David Hunt]

In the References section in the Power Management overview,
both links pointed to the same l3fwd-power app. Fix the links
so that one points to l3fwd-power, and the other points to
the vm_power_manager sample app.

Signed-off-by: David Hunt <david.hunt@intel.com>
---
 doc/guides/prog_guide/power_man.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index f55436bc9..8f23f7958 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -195,6 +195,8 @@ The mechanism can applied to any device which is based on polling. e.g. NIC, FPG
 References
 ----------
 
-*   l3fwd-power: The sample application in DPDK that performs L3 forwarding with power management.
+*   The :doc:`L3 Forwarding with Power Management Sample Application<../sample_app_ug/l3_forward_power_man>`
+    chapter in the :doc:`Sample Applications User Guides<../sample_app_ug/index>` section.
 
-*   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.
-- 
2.17.1

Re: [PATCH] doc/power: fix references in power management

[Kovacevic, Marko]

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Re: [PATCH] doc/power: fix references in power management

[Thomas Monjalon]

15/01/2019 14:38, David Hunt:
> In the References section in the Power Management overview,
> both links pointed to the same l3fwd-power app. Fix the links
> so that one points to l3fwd-power, and the other points to
> the vm_power_manager sample app.
> 
> Signed-off-by: David Hunt <david.hunt@intel.com>
> ---
>  doc/guides/prog_guide/power_man.rst | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
> index f55436bc9..8f23f7958 100644
> --- a/doc/guides/prog_guide/power_man.rst
> +++ b/doc/guides/prog_guide/power_man.rst
> @@ -195,6 +195,8 @@ The mechanism can applied to any device which is based on polling. e.g. NIC, FPG
>  References
>  ----------
>  
> -*   l3fwd-power: The sample application in DPDK that performs L3 forwarding with power management.
> +*   The :doc:`L3 Forwarding with Power Management Sample Application<../sample_app_ug/l3_forward_power_man>`
> +    chapter in the :doc:`Sample Applications User Guides<../sample_app_ug/index>` section.
>  
> -*   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.

Dave, when in doubt, please check at what is already in the tree:
	git grep :doc:
About the title, we don't use doc/power:
	git log --oneline --reverse doc/guides/prog_guide/power_man.rst

Re: [PATCH] doc/power: fix references in power management

[Mcnamara, John]

> -----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

Re: [PATCH] doc/power: fix references in power management

[Thomas Monjalon]

18/01/2019 13:15, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas@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.

[PATCH v2] doc: fix references in power management guide

[David Hunt]

In the References section in the Power Management overview,
both links pointed to the same l3fwd-power app. Fix the links
so that one points to l3fwd-power, and the other points to
the vm_power_manager sample app.

Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
---
 doc/guides/prog_guide/power_man.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index f55436bc9..0a3755a90 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -195,6 +195,8 @@ The mechanism can applied to any device which is based on polling. e.g. NIC, FPG
 References
 ----------
 
-*   l3fwd-power: The sample application in DPDK that performs L3 forwarding with power management.
+*   The :doc:`../sample_app_ug/l3_forward_power_man`
+    chapter in the :doc:`../sample_app_ug/index` section.
 
-*   The "L3 Forwarding with Power Management Sample Application" chapter in the *DPDK Sample Application's User Guide*.
+*   The :doc:`../sample_app_ug/vm_power_management`
+    chapter in the :doc:`../sample_app_ug/index` section.
-- 
2.17.1

Re: [PATCH v2] doc: fix references in power management guide

[Thomas Monjalon]

18/01/2019 10:34, David Hunt:
> In the References section in the Power Management overview,
> both links pointed to the same l3fwd-power app. Fix the links
> so that one points to l3fwd-power, and the other points to
> the vm_power_manager sample app.
> 
> Signed-off-by: David Hunt <david.hunt@intel.com>
> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Applied, thanks