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 4574CA034F; Fri, 7 May 2021 15:15:42 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B68814013F; Fri, 7 May 2021 15:15:41 +0200 (CEST) Received: from wout3-smtp.messagingengine.com (wout3-smtp.messagingengine.com [64.147.123.19]) by mails.dpdk.org (Postfix) with ESMTP id 64D9640040 for ; Fri, 7 May 2021 15:15:40 +0200 (CEST) Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailout.west.internal (Postfix) with ESMTP id DF8F5FE4; Fri, 7 May 2021 09:15:38 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Fri, 07 May 2021 09:15:39 -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= itcue+79+v5u7zZ2pvsJE0hrXJqTIOfPszHugk6YKww=; b=npW9/YSoHqVh6Wvu 5nk7XaWbtgkIVMm+95AWc+4vjzzM91yu/IOYFhzJcsE5YCWE7pXVptxCuO0OniIe cStv+e0fg9NDFC9rynSO3oFFIT8lyiWLN2I+KKcY0oyDp0k0sttbGamYwRwDlYSU 41gJk7y5esKy2gZa5dofWkAWkyeVLXGA/y+vXJF9ihvt+amb6HO3FSYfDSig94E+ Ji9DnNphpUKG0j37DpNiyGDSGCtIgZJDzoIJ88SvlDdVTOwC05gjz9rn73ZrRLaF d9qpMGJLPjSA2clPP/Do7EloJhVmvCiHLKiANAJnyY/BC2Q9Fav0To8CERFeMHa0 TKfz9Q== 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=itcue+79+v5u7zZ2pvsJE0hrXJqTIOfPszHugk6YK ww=; b=n7Pn/MphMP9/RrAciZshy3e/8zVSMJ60mD/hQN9p5oxXPIcmXSfcwLa6I EHW2vFK9QztCSJ8b15diIX4BYAzD6UpO+irdkegjfutc98iQ1Vfj80cyH/19Zykp /eyN3Aijl9qogDuy4PRtMDhBgsa1EZrfjXCLR+ZV8HHJiNhAenCI0/ri0mz/cn9W Z6HojBMgBl2NggtldaH0X+Kw1ZnqwMxWURFj6zosEYsN//wBt291z6BjuUePqbPj uPeiko8nGAszCdME5iaIqmPRtuY7NezNrRczMwnPc8otcGZA2ZJfe5F3K7mYCuhi Ik9RsKUL+QlXkclci5oEKpKBgs4Yg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdegvddgiedvucetufdoteggodetrfdotf 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; Fri, 7 May 2021 09:15:36 -0400 (EDT) From: Thomas Monjalon To: Conor Walsh , bruce.richardson@intel.com, "Burakov, Anatoly" Cc: john.mcnamara@intel.com, david.marchand@redhat.com, ferruh.yigit@intel.com, dev@dpdk.org, conor.fogarty@intel.com Date: Fri, 07 May 2021 15:15:34 +0200 Message-ID: <42643189.82yYazPPtX@thomas> In-Reply-To: <86c40b7f-1035-c8ab-f10a-bb9b3146249b@intel.com> References: <20210421091146.1384708-1-conor.walsh@intel.com> <20210506164059.694490-1-conor.walsh@intel.com> <86c40b7f-1035-c8ab-f10a-bb9b3146249b@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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 07/05/2021 11:54, Burakov, Anatoly: > On 06-May-21 5:40 PM, Conor Walsh wrote: > > +* ``start-after`` and ``end-before`` can use any text within a given file, > > + however it may be difficult to find unique text within your code to mark the > > + start and end of your snippets. In these cases, it is recommended to include > > Such lenient attitude still leaves room for accidental changes (e.g. > typo fixes, whitespace reformatting, language fixes etc.). I would've > preferred the scissor syntax to be mandatory for all comment snippets > for documentation. However, risk is pretty low so i can live with that :) Compiling the documentation is part of any reasonnable test, so the risk is very low. > > + explicit tags in your code to denote these locations for documentation purposes. > > + The accepted format for these comments is: