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 141C9A0547; Wed, 21 Apr 2021 16:17:57 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E795A41B17; Wed, 21 Apr 2021 16:17:53 +0200 (CEST) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 0191541B13 for ; Wed, 21 Apr 2021 16:17:50 +0200 (CEST) IronPort-SDR: O2hXEsIXzz9iuYmmPpviLXVqOmlO5CeVgyQF/l+itGsGmW8KNBrha2YOuzEiD9+dpO/Ez/uD5q v+TdOazSFxGg== X-IronPort-AV: E=McAfee;i="6200,9189,9961"; a="259657464" X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="259657464" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 07:17:32 -0700 IronPort-SDR: r0GlSNiuOJMVk/ZHIizSnE4S1CrLXjesmAvkYwp59J1M/llgLCRoytu4q6JiMrockJaVRvrzBw LeeMoCIcYMHw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.82,240,1613462400"; d="scan'208";a="455357975" Received: from orsmsx605.amr.corp.intel.com ([10.22.229.18]) by fmsmga002.fm.intel.com with ESMTP; 21 Apr 2021 07:17:31 -0700 Received: from orsmsx608.amr.corp.intel.com (10.22.229.21) by ORSMSX605.amr.corp.intel.com (10.22.229.18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2106.2; Wed, 21 Apr 2021 07:17:31 -0700 Received: from orsmsx602.amr.corp.intel.com (10.22.229.15) by ORSMSX608.amr.corp.intel.com (10.22.229.21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2106.2; Wed, 21 Apr 2021 07:17:31 -0700 Received: from orsedg603.ED.cps.intel.com (10.7.248.4) by orsmsx602.amr.corp.intel.com (10.22.229.15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2106.2 via Frontend Transport; Wed, 21 Apr 2021 07:17:31 -0700 Received: from NAM11-BN8-obe.outbound.protection.outlook.com (104.47.58.174) by edgegateway.intel.com (134.134.137.100) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2106.2; Wed, 21 Apr 2021 07:17:30 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=IRWSYMBLxEjp9+DPYh+0/9LEl7bBZcR46/yLfoqa7NLnC/aR/ih8Rugv++R0HJ8c2n3GP9wS0vIMw1wO72vQxJCsg+N7eidqeCIBs43d0dOoL2GH1kTqT7XHj+tGaa1dE7wgs8zu7HTpXKS9QecQcmI0RR3mTuDV8PgVjiAqnFXqq/fMJNeQjCKrja6l3jJoFEkeFTI8AnfaAomXPeTjqZPb87FPHKWLT8utew27b1NUkpfFS1adypqv3EI3zbmMQXTqBKkJmunTmkI1vRoo1J7XAxEL4jgIRIYyxDCTwBF2j2bbVvCN1KLkVAFKXt8zZfEKVtS5Hi/xnUrD+xbYoA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=+0ZkgB66morMSFQC5B3eRGjtZ5m6iRbdBa7rzg3yRS8=; b=fNPvxx5PVSJUBpCl8IVaqDNJj4YgcMVayH/Loa/5+1GvPSjeZjIOGlX75/IxT0Nv7ZASmzbxOSKc64F0oqXnqKr6afpIdQW3YO+WQGhyE7pUpaqFMrYKwWCyUdhWXPM4hWvs66UF6kTqBqtGBEzB5cOzKcoVr9qLNmTts4L68gg7nd3Sw4MJGtGcwvvrhDJQMZ5BXDtNcA/egamUhWzVHZqcT5usNrpGsVuNVSvJ8yHQhA53zHgg5Jma7j+wMuWjkdybSn91f3/zsA5Zf9u5zus0cZghzK6wmIDcvJXE6r/usxJEzyCRzyRrmcHvCDvN5ZtV9oYzcMdSLHWI7aZ01w== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=+0ZkgB66morMSFQC5B3eRGjtZ5m6iRbdBa7rzg3yRS8=; b=tb7giRS71YWa1KVQnWLJ99tt6hQeV1pmP2iRoR8Fh6xQ6hTXUOPCLyk8wFEBIRWBdPvVXd4xOJ2d+7ltgmY7Id12jkxYLDlMpKANITuXxwFuFXz5WX9+ZzNGgoAP2R/ga75VttJXKj5Fa4zzs/hbQVsAfTh+wBXkrb9i7uuuxNw= Received: from SN6PR11MB3086.namprd11.prod.outlook.com (2603:10b6:805:d6::14) by SN6PR11MB2894.namprd11.prod.outlook.com (2603:10b6:805:d7::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4042.19; Wed, 21 Apr 2021 14:17:26 +0000 Received: from SN6PR11MB3086.namprd11.prod.outlook.com ([fe80::2c1d:2561:8ed3:c837]) by SN6PR11MB3086.namprd11.prod.outlook.com ([fe80::2c1d:2561:8ed3:c837%6]) with mapi id 15.20.4042.024; Wed, 21 Apr 2021 14:17:26 +0000 From: "Mcnamara, John" To: Thomas Monjalon , "Walsh, Conor" , "david.marchand@redhat.com" , "Yigit, Ferruh" , "Richardson, Bruce" , "Burakov, Anatoly" CC: "dev@dpdk.org" Thread-Topic: [PATCH] doc/contributing/documentation: add info about including code Thread-Index: AQHXNo5owN7ZRQE6uEK9I7tJrf7Xy6q+wiRggAADq4CAAD68gA== Date: Wed, 21 Apr 2021 14:17:26 +0000 Message-ID: References: <20210421091146.1384708-1-conor.walsh@intel.com> <7938996.8XznLcKUNL@thomas> In-Reply-To: <7938996.8XznLcKUNL@thomas> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-reaction: no-action dlp-version: 11.5.1.3 authentication-results: monjalon.net; dkim=none (message not signed) header.d=none;monjalon.net; dmarc=none action=none header.from=intel.com; x-originating-ip: [86.40.59.22] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: be436c92-a56e-403f-10ba-08d904d030bf x-ms-traffictypediagnostic: SN6PR11MB2894: x-ld-processed: 46c98d88-e344-4ed4-8496-4ed7712e255d,ExtAddr x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:5236; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: jex/kCwO4MMF9lmzwE4cqgRqTIewXf98o4HS4H76Zy6pSsFI5hiBtdgcUr0LkgwNxE4BB19jWWUB5ChZ+Em/rzgjVaLZWoN+buu8T/yeWrVN9nEwFoBXtmT57fLNWKWtJT73Gsnncmt2g6CSva5942LaNkjH7S+y1AGG4IIQ0wmKQ4bCqo0a5j/P41v8o1BTRGuZMwMHiA+EWaLApFaLDz42EXQvNU9AqKSCK+3K/5koeDOonalK+LQNdoyc3LIavQGQXAme/CAQrOQoqtG3HvreWpTxTBD20i7o2BFoRiXe2H749BU656Sop5JRJXwmnNFEXMg5xDfFdfOKhIL99llSsWo1oy5a9jVwGParPA1KDXhNbo54gC4ff2MgjAg6nVmg2H/ewiNYQyrBAOzA4sfIeH4YgKZ948AwQTkI9O6tfFAt/0CM7g+B9pjQia0ZD5G5oe3Cej+hbLf9nkdPvc2Mul2mH6mvWUbDb7IL1mme2zn/VCex3Eye1sXgGoe5KwzAgZyxGAl1lhAJak3osPYTlcmWtb1qYJrs0D48rcmLPhKacxzihtwDwQSY5qjw3aOBDmr7LKcaQ/4r9tKtWfj9B6JrKB7gJaSWAo31FhYETw7jSDCY+trnBpvbkfFFsT1M/vCb41urbyW8cVDpew== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SN6PR11MB3086.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(396003)(136003)(346002)(39860400002)(376002)(366004)(83380400001)(66446008)(186003)(921005)(76116006)(66556008)(64756008)(86362001)(8936002)(2906002)(8676002)(4326008)(66476007)(71200400001)(52536014)(122000001)(66946007)(55016002)(38100700002)(478600001)(7696005)(6506007)(6636002)(4744005)(110136005)(5660300002)(53546011)(9686003)(26005)(316002)(33656002); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata: =?us-ascii?Q?nQjAGgeSqfj1pFaGz8t/t4oenPKgIvbdiBRkerlpYhlodARr2p7jGedKj40F?= =?us-ascii?Q?dEYge8DoZSST12BKt2zQsXwmBK2EzRqo9kLwfNswxN0KiHjOyxmNEIPC4ysN?= =?us-ascii?Q?Gc64w6XH1FDRQ7bEc7pIWRrh9+62P2gwzuRrt4J7nkS0ygtTO3UkCcQjNiNM?= =?us-ascii?Q?x2dRmEhh3Itghsrpx/U8FvELYauNazHHvu/1ao28osfFXBKeSuYfmhQgjBPi?= =?us-ascii?Q?9/cm+tz3txbuhbzTZzZS15QMXtlBUMmje66IgQX0ellQXQJ7qZSp+tHymj6a?= =?us-ascii?Q?2Yo8f9meNo4XHlvkxB9+hjfJfFBdMj3ElwEp0rXjcrM7owzFtTZi6Aleop7I?= =?us-ascii?Q?kBb4T2e6Loa3WhqQYInFsZ5Ql32nKq7tGU5W81AjxTS67cLGY2G2BH6ZsL0E?= =?us-ascii?Q?DOf9SoQyS454RRskxwKOD03fPkl9WJasJxOd/y7ThGeq2GSSt13MFwwmh1jL?= =?us-ascii?Q?RbXx/2Bg+7n5c9j/COju2eB4ympYwXnvoc2VCn1kSAdyB/Vdz3+S2qzXIRG8?= =?us-ascii?Q?gXrMR8B6EEKAWGxtMvb/enRRxYnE3UOVevCiYnMMjvLgS0frsIe6egTjsQgb?= =?us-ascii?Q?Zx0sbciaR93Efj2wHPahW83WYW+JhgOyOmVJe+/MmPwgCNjLE5qnY03nEKfG?= =?us-ascii?Q?RbR5kcrdVd5t5l4EPlnU+UhJks7qxTBgXFvU/NY7eYhY6u4um2PCkuTL5E+e?= =?us-ascii?Q?XgVc+ouBUA2jUoOyLeWyHlgvrQ3ICnln/pbPFg0VkxTq1BtX9wdTfHDflqaZ?= =?us-ascii?Q?YWfTWMFfm0ZwGchQiPPcSUomfdX0AyR030jko+d5rGH7nMLHoO7E+trTjIrP?= =?us-ascii?Q?epOW8ToHriBApTWo/Z7iUK+mSMdR5gxuEW7m5+YiZ/seU5zV57MZKPIy3lJR?= =?us-ascii?Q?pvPlPv+Dth9fvGFWPnpzLBlaB0vyivJlkmo6bjEULV1idOqRzEjFYW/MrTlu?= =?us-ascii?Q?0CZyttNKZ7YRRqYK0AeCHxjdkaEkfYUJD+O6ElXtpCRPfDACMQJ8KNfiJ72z?= =?us-ascii?Q?XHYuSWYR1o6rrobwS7Ofzy0YMzBfKEsilKzSBSa0IIT6rBy5yLMknU0cNJJw?= =?us-ascii?Q?W7R8t/6sronACJ1jaiTTsF64Dcahp5KiHOV2du+18HwBmCO4AptyZFkVgxRN?= =?us-ascii?Q?ccX/nhu7XU5qXfwJwNxvHZWRWeHf+3XAM3oCeJ33uXUjHFFa5ue1PPx0UMjW?= =?us-ascii?Q?BeORtg86Ol4CFh4iuZvcDODnZhFhSyBNJP9np9oYES/3x+QuCow/n8IPdupT?= =?us-ascii?Q?sbGB7LoR2D1FYfGFRNQFqlg4aqw6lxPe7YQfWkPW55RA6VHm4F74Z1UoZt0D?= =?us-ascii?Q?/gI=3D?= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: SN6PR11MB3086.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: be436c92-a56e-403f-10ba-08d904d030bf X-MS-Exchange-CrossTenant-originalarrivaltime: 21 Apr 2021 14:17:26.5833 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: F3SlZGC1aK4l/B67Nhf5ODbJ52DNzT9oa3+dWDp1WCE2MX8UFv4dk7eI97Z8Q9DnR7FBla/KCKGL1hlOG1Y1KQ== X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN6PR11MB2894 X-OriginatorOrg: intel.com 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" > -----Original Message----- > From: Thomas Monjalon > Sent: Wednesday, April 21, 2021 11:31 AM > To: Walsh, Conor ; david.marchand@redhat.com; > Yigit, Ferruh ; Richardson, Bruce > ; Burakov, Anatoly > ; Mcnamara, John > Cc: dev@dpdk.org > Subject: Re: [PATCH] doc/contributing/documentation: add info about > including code > > > > This is a very good suggestion and I think we should encourage doc > > writers to use this when including code in the documentation. >=20 > Yes, and we should try to clean-up existing code snippets. If there is no general objection to including code snippets this way then w= e could get someone to work on refactoring the sample code docs to use it. John