From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH] doc/power: fix references in power management
Date: Thu, 17 Jan 2019 19:51:25 +0100
Message-ID: <1919587.yrck2HIdBR@xps>
References: <20190115133835.52147-1-david.hunt@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, john.mcnamara@intel.com, marko.kovacevic@intel.com
To: David Hunt <david.hunt@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from wout2-smtp.messagingengine.com (wout2-smtp.messagingengine.com
 [64.147.123.25]) by dpdk.org (Postfix) with ESMTP id 1C02D2BFA
 for <dev@dpdk.org>; Thu, 17 Jan 2019 19:51:30 +0100 (CET)
In-Reply-To: <20190115133835.52147-1-david.hunt@intel.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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