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 0AF9AA0547; Wed, 21 Apr 2021 12:21:13 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C8A99419EC; Wed, 21 Apr 2021 12:21:12 +0200 (CEST) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id D9312419D3 for ; Wed, 21 Apr 2021 12:21:10 +0200 (CEST) IronPort-SDR: +WEYCpMiBFNofVqKwttmWBSdNRsfm6fDmHoM8z/VKmQVOm6DXJIFZ7Ao2v8U5uIlSMco2smoOd dzdY4NDwTg2A== X-IronPort-AV: E=McAfee;i="6200,9189,9960"; a="259628489" X-IronPort-AV: E=Sophos;i="5.82,238,1613462400"; d="scan'208";a="259628489" Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Apr 2021 03:21:09 -0700 IronPort-SDR: Z4C5OKv3jbvCnYhvMsYtw3GZ5pg8uWtaNjdy9Y6xi2yM4cnKwLVj2+3il5KSMxUwx2kWATkxZg DVg1G+shKxWA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.82,238,1613462400"; d="scan'208";a="614052484" Received: from fmsmsx606.amr.corp.intel.com ([10.18.126.86]) by fmsmga006.fm.intel.com with ESMTP; 21 Apr 2021 03:21:09 -0700 Received: from fmsmsx608.amr.corp.intel.com (10.18.126.88) by fmsmsx606.amr.corp.intel.com (10.18.126.86) 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 03:21:09 -0700 Received: from fmsmsx603.amr.corp.intel.com (10.18.126.83) by fmsmsx608.amr.corp.intel.com (10.18.126.88) 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 03:21:08 -0700 Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx603.amr.corp.intel.com (10.18.126.83) 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 03:21:08 -0700 Received: from NAM11-DM6-obe.outbound.protection.outlook.com (104.47.57.168) by edgegateway.intel.com (192.55.55.70) 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 03:21:08 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=P4HVp+PM+JfuRNr/cHWSliYPdw34QOOhdO6lATZGIWLLMmtGm4hNCP3p3cailK6L59Kp6TYyh6gOB7EyBSsDOPbKX8XL8IMa+vwiXSwrWfrxvak6P8qqkxOF5XGKk8XDBAi7SFUNuVYo+mgAHCYBmh0dSLPpbJMEshKt3r/mAIShUiAUntZI3kR1rdoGvbCgr4SikvTdFC4yP8YTKog+8xdAC+e7gUa608NE5H9wVOSyFrj/Dff/Wf2HdoUD+bZV01nzgKzyh6tmIs9fZbKBJ0siCEFX2wHyz26Trkuq/O+0ERzODKmbSHzvRryolvPKqUmPQYGwVG9dVXGPsCfYWA== 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=v4ttmAdFaWaR1oG9Ssznra+0iXK5BtBrPy8Vh7ARLDQ=; b=Viq2tSVne1RFLOYwAb1A2VMagSqe+VRX5fNLNxkkyfKELB+CWsw1TGPAteGAz7cBXxphLW3Yu2l4Qm2QtdR/Hm3ZiyN/GE93JcSIDnrbSomjXVdGN9wPADFUobnwmFMSSpy+1CW24CsDxOLO1QSbym5132Re/zIuy0o4toE9vRsDZBIAuRLALDLGJSFK7x3D1N6V801i/mZZsmYwcL7hnXy8CFmIzhLYDqR4TvGSDjF23mB+AI6E70sEgbctlnW+hTQxnqND5MaPJ8/BLeBhzuqaYx7LpUsZQ4KkKn7BXlWTX+Jh/jdF96WrgL4mXz6tgtLxcZW5k244caUJ7Fd45g== 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=v4ttmAdFaWaR1oG9Ssznra+0iXK5BtBrPy8Vh7ARLDQ=; b=w59KCjEjrJmtLOe40hTj8JLYmGxB638PIEPY6NTobvIIQ2u1wxexLj7Lu+DYMNrQqoZJsG8DaQluV0V995neyYcS2+HbuvjmLMpjj4xoXc+3L3jVqgDnHO+XbazMq5SNBhlwz3QIug4Yo/Vvbf5oaYKxolgQVlcCZXBK91Dcb/4= Received: from SN6PR11MB3086.namprd11.prod.outlook.com (2603:10b6:805:d6::14) by SA0PR11MB4640.namprd11.prod.outlook.com (2603:10b6:806:9b::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4020.17; Wed, 21 Apr 2021 10:21:06 +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 10:21:06 +0000 From: "Mcnamara, John" To: "Walsh, Conor" , "thomas@monjalon.net" , "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+wiRg Date: Wed, 21 Apr 2021 10:21:06 +0000 Message-ID: References: <20210421091146.1384708-1-conor.walsh@intel.com> In-Reply-To: <20210421091146.1384708-1-conor.walsh@intel.com> 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: intel.com; dkim=none (message not signed) header.d=none;intel.com; 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: fb4d1531-70a1-421f-a6c0-08d904af2cac x-ms-traffictypediagnostic: SA0PR11MB4640: 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:7219; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: eflsq5OJRBZdzScPRJfZaHH4eVnoziYS1PYXVE1crsJKVRNSAKTnVjeM7gftpvLHJYtsLgWJR1FkLIBBcNDvOcBjfNuwQn/vyuQ4vcwgrw50o1stXHO8B9IDajh+ElFzpTQ/Ff7Xy5WydPuk6QMsP37WgxUU4Jigb/eYhFjGg/CMxRUtc+FZdtblJByhJQq1TSWBJhAbM5FyHfCtLGRUZBLuFrgDc+RFPsoMLysNIv8JYxtwzkreuzlw/yvukATAFSYzn+4Q5rTpzQHh3LVlNVb4ihFBxs0cZrYh1esP8fjuWROFykV2MjKoL5tmQDzmbggRe79aBmaOixBZcsoxSpSdQJPU2pJz75D6OvCcn9cf34HGQS6mLbuxDhwlvqOK5UdHk4WMMqUftAYV098yCAZSMPZqA+n12rZ0AQ8VhDtv8IXx+8WgqdgDevNozOgVRjElFLz/S5W4ic9NQLLChqHCXuA2Vf12sr3gM+XTTW/QNhQcG9Jm1x7coIMo1TFv2N/+fdqC+bGdsLSAY8Jsxko2ETIAjAdrNaYd/Q59kUJbxQ/H1sCCLYTig0ix7U0OCaI6Z6MUCSoYiL2iWAUKteYuwgvquTdFlpDnyij+uZAszN/B0VcqP+WLuuytQTdFvM58ucBCp7RkMmz+MjO6yg== 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:(366004)(396003)(39860400002)(376002)(346002)(136003)(66556008)(66946007)(6636002)(71200400001)(64756008)(76116006)(7696005)(26005)(5660300002)(66446008)(110136005)(55016002)(86362001)(478600001)(921005)(2906002)(8676002)(122000001)(33656002)(4326008)(52536014)(53546011)(66476007)(186003)(83380400001)(316002)(38100700002)(9686003)(8936002)(6506007); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata: =?us-ascii?Q?RSbxjpiNJvhM3uclUUrkEKhd16Gnz1dKFFyC2CnsIFxJFnAc/7cb4oVpEuBC?= =?us-ascii?Q?X6RVl9Rt2o5rt6GFbOUh5BwnAAVzESvl0eEopuydFX7xIt4EpVxrFSeue/js?= =?us-ascii?Q?/Lm19JFepmy7qCLJAGO/SUmVLczdQgumpvjczqGNbcQQHGwr2U0IhtTn1+JW?= =?us-ascii?Q?hJJ2UCfrd3Ava1UL/xbB2iAW6a+khFPFcAjqIYhPOGEnKWdwVHtLjZ2O8leR?= =?us-ascii?Q?7xLLfH5gmoLS/6SppESRiHTJXOE7/jeqX+AiPRfIkNINJtdG9hQauLWZ5Kft?= =?us-ascii?Q?ZQDoZPZWg8X61CmC8AaDwDEUJTcNwcEHXyVpXqGGLbaYUJfq52ZLzomCuGMh?= =?us-ascii?Q?b/M2leq5TWjixVoh+NEmF6TM+d11hwAfJwWgcPHUOuSkIFyWMIS/rbt6ONgs?= =?us-ascii?Q?yw8B10QGvmua7BYNS2XTzJQq36H6KX+6qOfHhVHAamRKFN+2kpauS/kx3v1G?= =?us-ascii?Q?usIqM7yOU6ZtvwlpkJBEeYTxy20XRyeZ+KUhMTj+2U5D+LWqijCS5nNlFNhs?= =?us-ascii?Q?Nzxl+nPBhsSUwtaH4gD1CGNmfYAfqDqkG5sWcMnZ+9bykiUriwYkYZZgUsHb?= =?us-ascii?Q?xcPj9xI8FzzICPBEHKjOlPKUoObMo01Iut9KnKi3jq1OudhcsrDZid1l4jav?= =?us-ascii?Q?ibbNsMTTsEornHiXrrN3/thpj4ccphF3JHVoK1GnmreLTuLWCiAMBSN70+y0?= =?us-ascii?Q?j4SA3HNv4vQhL9dXht8b+lkmKYkMbPFEAvJN1EgQKJSnLgolotVmu2N1fvOL?= =?us-ascii?Q?XsxYvDotyhlL6t4hqB4gaqIjqHRk9eUvuDoVJzL7n4oaFLNXwr25bFewb0ji?= =?us-ascii?Q?UgddY8M+sZIBiFD1zZOcufwzxPqFTA4nL2GGNMfn96gwFlWGH9jsRDYuk30+?= =?us-ascii?Q?M10JwP5uN+8+doX4qoQcvGkRD0i/LuYwogxiHYCQe38waw0e1Vro8wGCYSvS?= =?us-ascii?Q?8+i0v+dkZl2wm2jFBxoruNr8vwLcFz90tw70CrjTvN9mvryaIgZsWNCoMn/9?= =?us-ascii?Q?C5Va7XDeFx52MgcTgNwW2EkyEiRVhm8oK7e4WQyWZ19TUwyxhtvZB8JahtJh?= =?us-ascii?Q?zyG4qRt7GLJTIT9dXIF8OV4Hi5B/0dgj6WhAEY1hGOvKBSRM7TNN3MyLFTgO?= =?us-ascii?Q?IGTo4IA550SENiBSLSF30797oOhojJ5SL8p/CYN6KTOAIQZKEZhPPmLNiwOT?= =?us-ascii?Q?EheUCcwp4e5tSrJQGi5a/0CKpiWgcpEMIESNIaV1BYgyb8hmQfPoPMl9CtzH?= =?us-ascii?Q?hSu8QKUcrfRM/1FT0mvp5S4Mdk20K0B9PIOowCKd0Poig5hW7PnkACEoUjdw?= =?us-ascii?Q?A6c=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: fb4d1531-70a1-421f-a6c0-08d904af2cac X-MS-Exchange-CrossTenant-originalarrivaltime: 21 Apr 2021 10:21:06.3257 (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: sqt5VYjw4FJOWJiN8RsRI9Nch+ZpfRYVXwHXIwr0+k974MlLqDcO6WXnNPiD+9/B+T3nNSUvnFJLZYJcqEWglw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA0PR11MB4640 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: Walsh, Conor > Sent: Wednesday, April 21, 2021 10:12 AM > To: Mcnamara, John ; thomas@monjalon.net; > david.marchand@redhat.com; Yigit, Ferruh ; > Richardson, Bruce ; Burakov, Anatoly > > Cc: dev@dpdk.org; Walsh, Conor > Subject: [PATCH] doc/contributing/documentation: add info about including > code >=20 > Currently the documentation describes how to add code snippets to the doc= s > 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 ensur= e > 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. Acked-by: John McNamara