From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH] doc/power: fix references in power management Date: Fri, 18 Jan 2019 15:31:52 +0100 Message-ID: <515953858.VWXKT8o3o3@xps> References: <20190115133835.52147-1-david.hunt@intel.com> <1919587.yrck2HIdBR@xps> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: "Hunt, David" , "dev@dpdk.org" , "Kovacevic, Marko" To: "Mcnamara, John" Return-path: Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) by dpdk.org (Postfix) with ESMTP id AAE661150 for ; Fri, 18 Jan 2019 15:31:55 +0100 (CET) In-Reply-To: List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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.