From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 2B525A0548;
	Wed, 19 May 2021 23:37:01 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 9AFEB40041;
	Wed, 19 May 2021 23:37:00 +0200 (CEST)
Received: from wout1-smtp.messagingengine.com (wout1-smtp.messagingengine.com
 [64.147.123.24]) by mails.dpdk.org (Postfix) with ESMTP id 4C16A4003F
 for <dev@dpdk.org>; Wed, 19 May 2021 23:36:59 +0200 (CEST)
Received: from compute1.internal (compute1.nyi.internal [10.202.2.41])
 by mailout.west.internal (Postfix) with ESMTP id 894881D27;
 Wed, 19 May 2021 17:36:57 -0400 (EDT)
Received: from mailfrontend2 ([10.202.2.163])
 by compute1.internal (MEProxy); Wed, 19 May 2021 17:36:58 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=
 from:to:cc:subject:date:message-id:in-reply-to:references
 :mime-version:content-transfer-encoding:content-type; s=fm1; bh=
 wMVpAt/Li2MIcHc5qmMXtrqTVEezJ43Tp0B2VgZFpuc=; b=VETlLfnP1n0vq88p
 N0YhVW5lBD0CIg+E8IJcCjSCpfYbwFBj3VLQuQq8oABo2hIFqBYFejLSObMOSXGH
 W+RtifdL00822UELtH6wUpuLPT4qFMcP7FOWILjYIDARc2P/HEP3qMwy+a2Q5VZm
 TXji3o+ZxylDY6elsE6+XM30LW/RATHfremrH13wgFl6rjTH/7mDObCgK4WWPGr0
 +eJ0ksCXNUX2xcoRJP6scVm8ISdlNg1bwkBH9BjMq7qxSNuNOGLYqfsuzZom4Ff4
 pZh6iipYq+LmiWLKdQuoWsoQa7Pme6RtNKMhqeMr2ZRd4PAKc0t5jqH9CC27zIMo
 GCpqlQ==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
 messagingengine.com; h=cc:content-transfer-encoding:content-type
 :date:from:in-reply-to:message-id:mime-version:references
 :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender
 :x-sasl-enc; s=fm2; bh=wMVpAt/Li2MIcHc5qmMXtrqTVEezJ43Tp0B2VgZFp
 uc=; b=CzuCSFFFKtfjRQO9zNHpqnQGZlrKfvWAFQH4898w2MuBlG+SnxGpddjZp
 anKNb1YFr9xbWVhr0qyy2IzgJfaEkRC/12nUQb/Q3qAaP63Xu3wcqU0jZAwN1yYU
 aC21IAmjaex+a1edIlS0twMMZHhWcSB2wv6wUTPtJqVpwMiRJZp+YSOr6CRO1L90
 a1S1aPwavYejNMcckZL2uFEFCoON+dfYTFAVgvmZumWSKhFVx8oSJqJVGCmjVVee
 /mOxSYgm362/XibS97gONAdHPJa3RuON/z+mXGE6eKiHVUNDr7ufv8nWDxmCmvTB
 FZ6Ktyaa1YiiLlj/qSyBUXMBeOBQA==
X-ME-Sender: <xms:-ISlYGw7XT6nuSpG7b723u0yTNSmODgel6pBNzZHlqLZI8SGXMo5VA>
 <xme:-ISlYCRxmwj4pt1o219EJ-0HoYm_a_m4dRnBIoZNV3rfbP1mwn86x6QIbs0JXR19c
 q8IoN8gRHhUF46KDw>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdejtdcutefuodetggdotefrodftvfcurf
 hrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecuuegr
 ihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjug
 hrpefhvffufffkjghfggfgtgesthfuredttddtvdenucfhrhhomhepvfhhohhmrghsucfo
 ohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtffrrg
 htthgvrhhnpeffvdffjeeuteelfeeileduudeugfetjeelveefkeejfeeigeehteffvdek
 feegudenucffohhmrghinhepughpughkrdhorhhgnecukfhppeejjedrudefgedrvddtfe
 drudekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhm
 pehthhhomhgrshesmhhonhhjrghlohhnrdhnvght
X-ME-Proxy: <xmx:-ISlYIXcZc4_4o54O8_1v4nES26HebJ8KqP-zIcl5HqjgK8RhCLusw>
 <xmx:-ISlYMjO_UqINAfSVU7M5S1Ie3j-BRL8K0lQQ9khNevZm1jotS7ymA>
 <xmx:-ISlYIB_fELRRqvbHffdoBG7KZJwfICQDe7953pjd4mBwMdHjLdWBw>
 <xmx:-YSlYH6F7oe90p8wvpn30hWj3MdqJJctgbtGvlZvJPwdP1V2RdkqRA>
Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184])
 by mail.messagingengine.com (Postfix) with ESMTPA;
 Wed, 19 May 2021 17:36:55 -0400 (EDT)
From: Thomas Monjalon <thomas@monjalon.net>
To: Conor Walsh <conor.walsh@intel.com>
Cc: john.mcnamara@intel.com, david.marchand@redhat.com, ferruh.yigit@intel.com,
 bruce.richardson@intel.com, anatoly.burakov@intel.com, dev@dpdk.org,
 conor.fogarty@intel.com
Date: Wed, 19 May 2021 23:36:52 +0200
Message-ID: <1934896.u7A4v8ZNKY@thomas>
In-Reply-To: <20210506164059.694490-1-conor.walsh@intel.com>
References: <20210421091146.1384708-1-conor.walsh@intel.com>
 <20210506164059.694490-1-conor.walsh@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
Subject: Re: [dpdk-dev] [PATCH v2] doc/contributing/doc: add info about
 including code
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
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>

06/05/2021 18:40, Conor Walsh:
> Currently the documentation describes how to add code snippets to the
> docs using code blocks. This can be problematic as the code snippets
> in the docs may fall out of sync with the actual code it is referencing
> within DPDK. This patch adds instructions to the contribution guide
> about how to include code in the docs using literalinclude which will
> dynamically get the code from source when the docs are generated. This
> will help to ensure that the code within the docs is up to date and not
> out of sync with the actual code.
> Note: literalinclude was used in the past and was removed from DPDK as
> it created an issue with PDF generation but this is not done anymore:
> git.dpdk.org/dpdk/commit/?id=d3ce1dc637c1bbef9a407f10281b2bc0549256da
> 
> Signed-off-by: Conor Walsh <conor.walsh@intel.com>
> Acked-by: John McNamara <john.mcnamara@intel.com>
> Acked-by: David Marchand <david.marchand@redhat.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks.