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 459D143279; Fri, 3 Nov 2023 14:11:32 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 33D2C4027F; Fri, 3 Nov 2023 14:11:32 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 3CFEC40273 for ; Fri, 3 Nov 2023 14:11:31 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1699017091; x=1730553091; h=date:from:to:cc:subject:message-id:references: in-reply-to:mime-version; bh=OmPN+Fg0ObezmDyWccPY5hyPafapm/EBfCwg8SPwEjw=; b=bdqLjifNl1tIwotf/zjkkA74R+L0mbFAQIG712+ZViDYKXm+MjWMfkch d/FFo+Nu4npEX29beUhG8v6XK+eWv3zr6woCPd1yNhjiLeLMYqaO9nRXo 72PgDT/2FupvcTz4MLcCjUJ0+ja087Pg4whi9kJu5CwKfk9/16LzZ+oXU SLkG1srYciNGOG8cBoYq5SZ/i11eaowscyHnw5+bpeoUCnbvNov2Pun2q gegR1U94zBSaXM9DxSX39F38lyyFXuUbOBcwPLoER7Rlx4Up8QgOgLVpp yYKXz5bZZo5fK9GS10xWrMDa1g4n/ZWNoL9Rmoa+fAshl/VZOSO2MOSlN g==; X-IronPort-AV: E=McAfee;i="6600,9927,10883"; a="455432373" X-IronPort-AV: E=Sophos;i="6.03,273,1694761200"; d="scan'208";a="455432373" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Nov 2023 06:11:30 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10883"; a="905340900" X-IronPort-AV: E=Sophos;i="6.03,273,1694761200"; d="scan'208";a="905340900" Received: from fmsmsx602.amr.corp.intel.com ([10.18.126.82]) by fmsmga001.fm.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 03 Nov 2023 06:11:30 -0700 Received: from fmsmsx611.amr.corp.intel.com (10.18.126.91) by fmsmsx602.amr.corp.intel.com (10.18.126.82) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34; Fri, 3 Nov 2023 06:11:29 -0700 Received: from fmsedg602.ED.cps.intel.com (10.1.192.136) by fmsmsx611.amr.corp.intel.com (10.18.126.91) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34 via Frontend Transport; Fri, 3 Nov 2023 06:11:29 -0700 Received: from NAM12-MW2-obe.outbound.protection.outlook.com (104.47.66.41) by edgegateway.intel.com (192.55.55.71) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.34; Fri, 3 Nov 2023 06:11:29 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=GpDdLiGXPdgQ4b0Seq5t4PkLQ5cUmXFO6qn+cJk+ki57VnTsV2WD8q5NBrylJHu457bfBBFuTiSpsbVJuyFFrmouLdxiQUM0QCgbd5QG+gfpmRPySXImA9sxL01ie0sqdCQHalFEClo9U6yLynbJqfAHQ1YG5dYr222qG5hul1N+ccXwNRaEkGEZb70vz+w27EnDtZSgRoFrZWVNMoGfw18HjSVQTayeFaLVdpJ3z+hZrvuWcAe/9l9V2CCLwIPAlbbzNsmyQ7mgGdfJKtgth4ZmoiWEh/iYYGvVW9SbsYeC8hIj9labn99PTOkl2ps2EKE0/FYDuVttdT/La0iOtg== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=3tZm4Ow+/hlVJTjoUDZ8EU0Q9bwyh66+0U9E3VRnXVA=; b=msrvia/ycUCB6o4IgTEHCazS+lxAdllFsL3cZx7eZI6elbaFx9m8rpICL067RAdSba5aBJuMuXcqHe2OicpAtnHLnOGoL67xdDWxOGvZgOYoWw5YkiQ2BGzM2oei6B0L/7+OuNXJap9DnZz3/g68/mPE8gonT5//tZaBlQCEYEWeCMqokSvAVE1Z4um9P1Rrryr5y67Upo72sZUuDEdQVV9+wbWOEHvgvvp9yZxxOQ/oTzKWNiAA6z0dvorDaHw7z9YE48cwLrJDW7tFJmice7xka4K7Cp+HKkNC5xJrD4ZPu7JaZ0SGralsfSZI4mMjb5BqWczPoRjxRocUX/UDvQ== 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 Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) by DM4PR11MB5996.namprd11.prod.outlook.com (2603:10b6:8:5f::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6954.19; Fri, 3 Nov 2023 13:11:27 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::d70b:11a0:d28f:ec44]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::d70b:11a0:d28f:ec44%6]) with mapi id 15.20.6954.021; Fri, 3 Nov 2023 13:11:27 +0000 Date: Fri, 3 Nov 2023 13:11:22 +0000 From: Bruce Richardson To: David Young CC: , Aaron Conole Subject: Re: [PATCH v3 1/7] Section 1: Introduction Message-ID: References: <20231103040202.2849-1-dave@youngcopy.com> <20231103040202.2849-2-dave@youngcopy.com> Content-Type: text/plain; charset="us-ascii" Content-Disposition: inline In-Reply-To: <20231103040202.2849-2-dave@youngcopy.com> X-ClientProxiedBy: DB9PR05CA0017.eurprd05.prod.outlook.com (2603:10a6:10:1da::22) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|DM4PR11MB5996:EE_ X-MS-Office365-Filtering-Correlation-Id: d612b1a1-eec4-4a4e-3b34-08dbdc6e62f1 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: mi9zyf2YCRauSq+vsKw2SClvu73c5FvUfwkwwmFeXmKz/NNSEBFqmgOitQyLFyoWfmAzq4sZDXfyNc40ZI+U8hn+m2pVGHsWnkQs0qWfCVGJLldnN1bgTRGzoOS7SkNR/dXcDgJrEANAQum6FSkY9/zKLbhLSgMQiUtYVnXfZfcHwp4B4yrYcBsD+Nr/zDsQkBxbvgixJruBjqvAjWlIY4GxhaFWrG5U4Zq7PndxXoaNAXC5EWNEADO1hU4C/saaaXQgtnkCE3MX9bvHwA9ndLxRkLV/MoqyIYaa89G4dLhucRvAAKV5o4HpbGleAAajV6lzFVgnZnSyiIlVhNyiddOIWbM8rogmyNBuGn8O5BN/AjCZJR4HrewGHrusqUAlYe1OFA53jeeugF7wLJ+Wu2PgtwovCr1VdvCeWsQ2Pk/kUGjFToEPPAImy3o2BXKfpnoM752xkjJh+o66YSvPEBA8rvmyURrjpnP8qH/nIFqgAUkxzbDkhDE0YvLOTNmFoZNdkJ5FAL0PvVKP4/wP+evU/S21qlZObcUcmxoLV2zvUN2rn4GPLLWZuMNkzHXzFTm2wSIKyond5rignMGEr3ZOuQzn/AzEOuYqPU+dQkeH2EE7tC6WROnHT8sWMEo1fFNe/ALjflNUipLLUELr8A== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(346002)(366004)(136003)(396003)(39860400002)(376002)(230273577357003)(230922051799003)(230173577357003)(64100799003)(1800799009)(186009)(451199024)(6666004)(6506007)(5660300002)(66946007)(6916009)(26005)(66476007)(66556008)(478600001)(6512007)(6486002)(316002)(8936002)(66899024)(8676002)(4326008)(83380400001)(2906002)(86362001)(41300700001)(44832011)(82960400001)(38100700002)(67856001); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?pdWz4mZs6avtRQX0qGpZTNd4M0HRF+SgO0yuM2Gmye+g7os4+AKGfhny9sfv?= =?us-ascii?Q?PQ3xqXNQuoVZjMc95MeZbYcbtIdJeyPUdZuIX2+Os7nu69KRjStgVBGke5zH?= =?us-ascii?Q?KSDjwR/ej3IJZiLpyFxekXJiRcFzR+WUPpxDIp/hDQK6kg/oXp4b7foyqwwm?= =?us-ascii?Q?hUezrnPo4671wWl3kIkEdcwsQkEIZz9X9nzleIMSpkJvjJ+s1wXDCj0scXxm?= =?us-ascii?Q?YgNdvXUpZpQbWDtkb5VQjvD40P1VHYmnj/5hrvMbEgdeLf/gdpfoXHs9JNc4?= =?us-ascii?Q?WAFTr6BUjcHMyazSe0F+IlkKT+KfQV999eQy3hDuaAQw3cC5L+c+g80prAIw?= =?us-ascii?Q?eczLvXzpIngnTEQQ7RBMQWjL71S6AxEtjo3YMDpPP3PEZ72jR3cSIwybSNHR?= =?us-ascii?Q?0tbkkBEJauFNSrXLwKzGp3IJJFO3xLJIp7n2uO2JYQDvS18iSOdustz+7KhT?= =?us-ascii?Q?jI7JeYQxB94wcl/pzNECvICKnLzJWmfdJgd90qdgd/fGuEev0jN/GtmQ7ugu?= =?us-ascii?Q?N5ejZTXO+B50RXqHIow8C6ps780Mr2X58sfk/DBxBF9eCRTOaQjiR+pt52xV?= =?us-ascii?Q?XioPlZblDfE3ltFeXp14IApgSQJQOMqyDlE7Ybyq4CWIZMOWthrdqysNKs6R?= =?us-ascii?Q?fIVgm6OhIafxMTLw3xxaRGaquFysVWq6GVKfJbe5SqYwwUBF33NnS5iMfajZ?= =?us-ascii?Q?NOdoJlE5MsnEN8HNM9T8ewcH2j6+ARVMKQKA+D4lW+uuXAy03Z29XMKhq8xr?= =?us-ascii?Q?T5tL7SIenFzMY/uuLyEBWzUFAerUZW+IhYnsbCM9nEA3CVwxO4Rm29/H6TEY?= =?us-ascii?Q?pI2FnoBRBeRo2IjH5/7vaiTLv/yECdM2OCA+A+MAK0p3EBarszzpiv92bbMD?= =?us-ascii?Q?CE6NLGrnn+hi13/EGtwVsdDmZSfihW3uriMIetJkc2g+VEIteT1Om53KNote?= =?us-ascii?Q?tS1JybP8zUPT0bTyWj1465yfPVrGUF3DxN9UWThJSIancKykkvEKtIaHORDC?= =?us-ascii?Q?LuLMN9DVw9SE1DlMr7nRajDB/zKgNq5UXxoadtFwY8pjnYXDHlknCl7fF7FK?= =?us-ascii?Q?Q/eS2iKoQDLuEzBHb9uCnZVgENxPCnsP2ZhAe4cm6ocmcnMLj0RfMveAf+9u?= =?us-ascii?Q?jIiDmRX7xLTFU0uDoJBI+M3VVCEP1WM3WK4pMgjTCKv2gsxxzR5y1dSq5YHy?= =?us-ascii?Q?6pzYX+n0zFUcybCyeUvS0TgyKo62YAKG6ed5aoLpqLpTeXHzHYhmqb4u/vez?= =?us-ascii?Q?6KJS0D+a6zRc/C/gNctgVBu9QHkUQjDLWtv1DdZYlk/UvAg9Nii3aC27NF7A?= =?us-ascii?Q?RPJM3QWPu9XRFbMHDpVvMu/bNNFTP7ter3QTqkO0GCm5R5mrS5or9mYYRqOM?= =?us-ascii?Q?PdDmVt2f3F6/Jf6pDaxopJhfPwpzIgMXUxZGj5a6TK/fwe3v/eOCcCyyO1nF?= =?us-ascii?Q?kS2L6k59Ba24u52gdHGxt8tp8e9zJDK6I0q3Pjsf6m5HMNUeTJQ+lqIW+7VS?= =?us-ascii?Q?SBe0EnY89L2dddd3ZSJd2seLr3APjcjVSlGBM+F9krf/lEXQakcosOPn9jL1?= =?us-ascii?Q?FZXy+p2C3TXZ8MaEN1LjH4tiEc0heE4ezHtF6O+kaSVPulOLpiPzKBdY55Sj?= =?us-ascii?Q?fQ=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: d612b1a1-eec4-4a4e-3b34-08dbdc6e62f1 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Nov 2023 13:11:27.0965 (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: 4ERoDNC2tw0/rqVuj/Q305+Vv9ozzPs9kqEN9afak1vawG4QOoq3Ed2MAsED7NwQsaXOPimjc35KidnWE+21d0CxQ0BQ6cYE6xR5qMid0QQ= X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR11MB5996 X-OriginatorOrg: intel.com 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 On Fri, Nov 03, 2023 at 12:01:47AM -0400, David Young wrote: > Edited copy to be simpler based on feedback. Thanks David, some small comments inline below. > --- > doc/guides/getting_started_guide/intro.rst | 13 +++++++++++++ > 1 file changed, 13 insertions(+) > create mode 100644 doc/guides/getting_started_guide/intro.rst > > diff --git a/doc/guides/getting_started_guide/intro.rst b/doc/guides/getting_started_guide/intro.rst > new file mode 100644 > index 0000000000..538b3bacec > --- /dev/null > +++ b/doc/guides/getting_started_guide/intro.rst > @@ -0,0 +1,13 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2010-2014 Intel Corporation. > + > +Introduction > +============ > + > +Welcome to the getting started guide for the Data Plane Development Kit (DPDK) covering Linux, FreeBSD, and Windows. DPDK is a set of libraries and > +drivers that accelerate packet processing and allow the user to create high-performance > +networking applications. The line breaks are in odd places here. Since we track the documentation as text files in our repository, like source-code, we want future changes to minimise the lines being changed as much as possible. Checking our contributors doc, I think our guidelines there for documentation changes are out of date, so here are the "working guidelines" I use for docs: * line length can be up to ~100 chars, maybe a bit more if it makes sense to avoid breaks * Start each sentence on a new line (unless you have two really short ones that both fit on one line!) * When breaking a sentence across two lines, split at a punctuation mark, like a comma, or before an "and" or "but" etc. Each clause should be on a single line where possible. > + > +The guide is structured to provide basic step-by-step instructions with OS-specific instructions for each operating system where necessary. should we add "got setting up and using DPDK" after "instructions"? for the OS-specific instructions, should be say that they are "only" where necessary, to try and emphasise we have things as common as possible? > +By the end of this guide, you should have a solid understanding of how to implement and > +use DPDK in your networking projects, regardless of the operating system you are using. > \ No newline at end of file Please fix this little warning. POSIX standard specifies that all text files should end with a newline character. Rather than having to add it manually, many editors have a setting to ensure it is there automatically, so that might be worth investigating.