doc/power: fix references in power management
PATCH 1/1 doc/power: fix references in power management
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.
--- doc/guides/prog_guide/power_man.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
doc/guides/prog_guide/power_man.rst +4 -2
@@ -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.
Signature · 1 line
2.17.1
15/01/2019 14:38, David Hunt:
Quoted 15 lines
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_managersample app.Signed-off-by David Hunt <[email protected]>--- doc/guides/prog_guide/power_man.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)doc/guides/prog_guide/power_man.rst +0
-0
doc/guides/prog_guide/power_man.rst The mechanism can applied to any device which is based on polling. e.g. NIC, FPG · line 202
Quoted 10 lines
doc/guides/prog_guide/power_man.rst +4
-2@@ -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
Quoted 18 lines
-----Original Message-----
From: Thomas Monjalon [mailto:[email protected]]
Sent: Thursday, January 17, 2019 6:51 PM
To: Hunt, David <[email protected]>
Cc: [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>
Subject: Re: [dpdk-dev] [PATCH] doc/power: fix references in power management
...Quoted 1 line
-* The "L3 Forwarding with Power Management Sample Application"
chapter in the *DPDK Sample Application's User Guide*.
Quoted 1 line
+* The :doc:`VM Power Management
Application<../sample_app_ug/vm_power_management>`
Quoted 1 line
+ chapter in the :doc:`Sample Applications User
Guides<../sample_app_ug/index>` section.
Quoted 7 lines
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
18/01/2019 13:15, Mcnamara, John:
Quoted 17 lines
From: Thomas Monjalon [mailto:[email protected]]
Quoted 8 lines
...
Quoted 1 line
-* The "L3 Forwarding with Power Management Sample Application"
chapter in the *DPDK Sample Application's User Guide*.
Quoted 1 line
+* The :doc:`VM Power Management
Application<../sample_app_ug/vm_power_management>`
Quoted 1 line
+ chapter in the :doc:`Sample Applications User
Guides<../sample_app_ug/index>` section.
Quoted 7 lines
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.
Quoted 6 lines
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 1/1 doc: fix references in power management guide
In reply to David HuntIn 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.
--- doc/guides/prog_guide/power_man.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
doc/guides/prog_guide/power_man.rst +4 -2
@@ -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.
Signature · 1 line
2.17.1
Thomas Monjalon
AppliedRe: [PATCH v2] doc: fix references in power management guide
18/01/2019 10:34, David Hunt:
Quoted 7 lines
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_managersample app.Signed-off-by David Hunt <[email protected]>Acked-by Marko Kovacevic <[email protected]>
Applied, thanks