From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 019E0A0547; Wed, 21 Apr 2021 12:31:24 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 77A47419EC; Wed, 21 Apr 2021 12:31:24 +0200 (CEST) Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by mails.dpdk.org (Postfix) with ESMTP id C4287419D3 for ; Wed, 21 Apr 2021 12:31:23 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id 63F595C00D3; Wed, 21 Apr 2021 06:31:21 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Wed, 21 Apr 2021 06:31:21 -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= HkbFOc/HejJtYDF0k3zYH6EAKt/qYPqsEFwg74VtMk4=; b=xnzODMd6dS4gBct+ O3BBXhBJnosdK1ZbSroM71jdQ+ckfj6KEsp2BIhg13V/QPRPOPu5I7q3ZxYeCSnf puKmAmq0ercSONsMuLJ2JCIWkkkVSzRbRgWhH3bO8sYX+Xf5yDIudCtkIOUkaoDA hPXHqM5zcHe/Ut3oxozWyjBhtZn1wAXpktxP4rKZNXwerZrlK4Dk3BcJufyHn1qN Slhdud1/+JqQ7qythxsGol3Ulw7AnrqOSn0KHgmqTEOYgRwHihGBwRtL0jeNo01k dJW+3tPbKgzgsAW4KCkTMe8x8VgI1Q6L5E1U7aoUurALSNQKbLDu7kDSkilmEFVE ng666Q== 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=HkbFOc/HejJtYDF0k3zYH6EAKt/qYPqsEFwg74VtM k4=; b=SK+u+SvYy1E9MOoVWb1utWUuTHEWutGoS9ZYZMgyBCPeyTlKlMGQaDdqv vCZ64aiiUTB/k4RvMgBc18xYTUTGHi0ZPPJnbhBnPxjNTVm8NV4mi/lHOV2gXGZ2 8SRifyPe4fId0USeNHCbN329Hhiawry3UYRWGYsFJP37uxU6XxYWJ2qGsGsnGwZv ocwI9IpocZ4Nv5/XRPTVsAPjvYfu5bR97LO7T8Z7Yo8P4abNc2Lnky+mQxQh97YN qYGwXFHvjoe6cghDEhdVnnBgPfhT2AzftDaeDJMi2BOWYEOGmqamHy5o2YZcaxyQ X18MLlAxLiVWv/531kt1v6zKx7Daw== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvddtkedgfedtucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkfgjfhgggfgtsehtufertddttddvnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepudeggfdvfeduffdtfeeglefghfeukefgfffhueejtdetuedtjeeu ieeivdffgeehnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id C2004108005F; Wed, 21 Apr 2021 06:31:19 -0400 (EDT) From: Thomas Monjalon To: "Walsh, Conor" , "david.marchand@redhat.com" , "Yigit, Ferruh" , "Richardson, Bruce" , "Burakov, Anatoly" , "Mcnamara, John" Cc: "dev@dpdk.org" Date: Wed, 21 Apr 2021 12:31:17 +0200 Message-ID: <7938996.8XznLcKUNL@thomas> In-Reply-To: References: <20210421091146.1384708-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] doc/contributing/documentation: add info about including code X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 21/04/2021 12:21, Mcnamara, John: > From: Walsh, Conor > > 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. > > This is a very good suggestion and I think we should encourage doc writers > to use this when including code in the documentation. Yes, and we should try to clean-up existing code snippets.