From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm1-f67.google.com (mail-wm1-f67.google.com [209.85.128.67]) by dpdk.org (Postfix) with ESMTP id 01CC05B12; Fri, 12 Apr 2019 12:13:43 +0200 (CEST) Received: by mail-wm1-f67.google.com with SMTP id z24so10374237wmi.5; Fri, 12 Apr 2019 03:13:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=kKhYhdkoYHu/Gzfp0YfU3ZIwMcviykYfOrZKtDd+pwk=; b=cI9/2Rh3ecOd1Zy0lCzdn7kwVXfjXKcMPjfu2J77zd0F1FUcnzPFT+dWmN0lBcG7U0 V8CUvh8OAN65X2RRZvs9uluQG148bbC4kE/oTBtZtyMeCX74ZuDqM3A1vTAbrYXuIsaH ykXMlXj1WBr6Mbt60ict7/mRiZNZeec/Fh0o+3KwvhlL7nt6jXrvg5pZmxhX/MK9K4st aqpnwhCt1cxrKeBBvkIhgqePwxH5+UGaffvZlcWRnkZGF3JP6oGtOD//7Q4HDgBIaey6 TalxXCumdfHaDyqqPKQ+HrpnJPSyQu+mfTOIqx06korvh53joZJ6C2pBwje0HOJXzZC5 R5aA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=kKhYhdkoYHu/Gzfp0YfU3ZIwMcviykYfOrZKtDd+pwk=; b=p8+F5uO1m3i3AMBV4rZ5gX2o3lM38IE19G+iP1/5uUcayonLRGvhWk/+7GoiKGc72C a/vAYkr/ExoW6Vk4KMcfSINW7qJyF8cg8Rk3+98aOkEbEGvRN8Dd0y38V5YoiQZYRCrV QDBEeDMcyzon8YD/O/lgbAdGy7/wr+Gyvy8iSlE3DYOyFayWiZzrtxR+KfHmnQFePhsi 6pMq3RRyRUDIr0Y4t1fD7Ogq3rMWuZJKQqosZBa2QxHaqnNxSLYXFcDVW3X9/njgBlRg 7sMbQouTG7dBIUygrLdrGhmy919VWVPPSszwA9CWGdFK9VL9GoYgRttZ9gsw+0QUwHz3 3rIQ== X-Gm-Message-State: APjAAAVcrYnW5tiI5Nyano3Wt2Ohe5py7CiAnb49NeKZcgD7GFPpPEH1 oiaLOLVLrBSMQ6LRirZbaGzsCiC/ku5UksjQ X-Google-Smtp-Source: APXvYqxiYzbFa1ozbUq0ZL1u7Rg45H7+QBwrypV2PofLnrM8rS/F0JrnMmE0Zt73Ysc7FH3A5PyMHQ== X-Received: by 2002:a1c:ce:: with SMTP id 197mr10593703wma.105.1555064023487; Fri, 12 Apr 2019 03:13:43 -0700 (PDT) Received: from localhost.localdomain (bzq-79-177-40-143.red.bezeqint.net. [79.177.40.143]) by smtp.gmail.com with ESMTPSA id t74sm14944389wmt.3.2019.04.12.03.13.42 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Apr 2019 03:13:42 -0700 (PDT) From: Rami Rosen To: dev@dpdk.org Cc: fiona.trahe@intel.com, akhil.goyal@nxp.com, john.mcnamara@intel.com, marko.kovacevic@intel.com, stable@dpdk.org, Rami Rosen Date: Fri, 12 Apr 2019 13:13:25 +0300 Message-Id: <20190412101325.5272-1-ramirose@gmail.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH V2] doc: add guideines for initial PMD submission X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 12 Apr 2019 10:13:44 -0000 This patch for DPDK Contributor's Guidelines indicates the repos against which a new PMD should be prepared; for example, for new network ethernet PMDs it should be dpdk-next-net, and for new crypto PMDs it should be dpdk-next-crypto. For other new PMDs, the contributor should refer to the MAINTAINERS file. Though this may seem obvious, it is not mentioned in DPDK documentation. Cc: stable@dpdk.org Signed-off-by: Rami Rosen --- V2 changes: * Fix according to feedback from Fiona Trahe and Akhil Goyal. doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index d8404e623..110cac41e 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -148,6 +148,14 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * If you add new files or directories you should add your name to the ``MAINTAINERS`` file. +* Initial submission of new PMDs should be prepared against a corresponding repo. + +* Thus, for example, initial submission of a new network PMD should be prepared against dpdk-next-net repo. + +* Likewise, intial submission of a new crypto or compression PMD should be prepared against dpdk-next-crypto repo. + +* For other PMDs and more info, refer to the ``MAINTAINERS`` file. + * New external functions should be added to the local ``version.map`` file. See the :doc:`Guidelines for ABI policy and versioning `. New external functions should also be added in alphabetical order. -- 2.19.2 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id E23C9A0096 for ; Fri, 12 Apr 2019 12:13:49 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 3BC7E5B2E; Fri, 12 Apr 2019 12:13:46 +0200 (CEST) Received: from mail-wm1-f67.google.com (mail-wm1-f67.google.com [209.85.128.67]) by dpdk.org (Postfix) with ESMTP id 01CC05B12; Fri, 12 Apr 2019 12:13:43 +0200 (CEST) Received: by mail-wm1-f67.google.com with SMTP id z24so10374237wmi.5; Fri, 12 Apr 2019 03:13:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=kKhYhdkoYHu/Gzfp0YfU3ZIwMcviykYfOrZKtDd+pwk=; b=cI9/2Rh3ecOd1Zy0lCzdn7kwVXfjXKcMPjfu2J77zd0F1FUcnzPFT+dWmN0lBcG7U0 V8CUvh8OAN65X2RRZvs9uluQG148bbC4kE/oTBtZtyMeCX74ZuDqM3A1vTAbrYXuIsaH ykXMlXj1WBr6Mbt60ict7/mRiZNZeec/Fh0o+3KwvhlL7nt6jXrvg5pZmxhX/MK9K4st aqpnwhCt1cxrKeBBvkIhgqePwxH5+UGaffvZlcWRnkZGF3JP6oGtOD//7Q4HDgBIaey6 TalxXCumdfHaDyqqPKQ+HrpnJPSyQu+mfTOIqx06korvh53joZJ6C2pBwje0HOJXzZC5 R5aA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=kKhYhdkoYHu/Gzfp0YfU3ZIwMcviykYfOrZKtDd+pwk=; b=p8+F5uO1m3i3AMBV4rZ5gX2o3lM38IE19G+iP1/5uUcayonLRGvhWk/+7GoiKGc72C a/vAYkr/ExoW6Vk4KMcfSINW7qJyF8cg8Rk3+98aOkEbEGvRN8Dd0y38V5YoiQZYRCrV QDBEeDMcyzon8YD/O/lgbAdGy7/wr+Gyvy8iSlE3DYOyFayWiZzrtxR+KfHmnQFePhsi 6pMq3RRyRUDIr0Y4t1fD7Ogq3rMWuZJKQqosZBa2QxHaqnNxSLYXFcDVW3X9/njgBlRg 7sMbQouTG7dBIUygrLdrGhmy919VWVPPSszwA9CWGdFK9VL9GoYgRttZ9gsw+0QUwHz3 3rIQ== X-Gm-Message-State: APjAAAVcrYnW5tiI5Nyano3Wt2Ohe5py7CiAnb49NeKZcgD7GFPpPEH1 oiaLOLVLrBSMQ6LRirZbaGzsCiC/ku5UksjQ X-Google-Smtp-Source: APXvYqxiYzbFa1ozbUq0ZL1u7Rg45H7+QBwrypV2PofLnrM8rS/F0JrnMmE0Zt73Ysc7FH3A5PyMHQ== X-Received: by 2002:a1c:ce:: with SMTP id 197mr10593703wma.105.1555064023487; Fri, 12 Apr 2019 03:13:43 -0700 (PDT) Received: from localhost.localdomain (bzq-79-177-40-143.red.bezeqint.net. [79.177.40.143]) by smtp.gmail.com with ESMTPSA id t74sm14944389wmt.3.2019.04.12.03.13.42 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Apr 2019 03:13:42 -0700 (PDT) From: Rami Rosen To: dev@dpdk.org Cc: fiona.trahe@intel.com, akhil.goyal@nxp.com, john.mcnamara@intel.com, marko.kovacevic@intel.com, stable@dpdk.org, Rami Rosen Date: Fri, 12 Apr 2019 13:13:25 +0300 Message-Id: <20190412101325.5272-1-ramirose@gmail.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH V2] doc: add guideines for initial PMD submission X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 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" Content-Type: text/plain; charset="UTF-8" Message-ID: <20190412101325.x5ybgMbdqjvObHUPxdPSbhivUqfgnSze9_7YGWp_J74@z> This patch for DPDK Contributor's Guidelines indicates the repos against which a new PMD should be prepared; for example, for new network ethernet PMDs it should be dpdk-next-net, and for new crypto PMDs it should be dpdk-next-crypto. For other new PMDs, the contributor should refer to the MAINTAINERS file. Though this may seem obvious, it is not mentioned in DPDK documentation. Cc: stable@dpdk.org Signed-off-by: Rami Rosen --- V2 changes: * Fix according to feedback from Fiona Trahe and Akhil Goyal. doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index d8404e623..110cac41e 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -148,6 +148,14 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * If you add new files or directories you should add your name to the ``MAINTAINERS`` file. +* Initial submission of new PMDs should be prepared against a corresponding repo. + +* Thus, for example, initial submission of a new network PMD should be prepared against dpdk-next-net repo. + +* Likewise, intial submission of a new crypto or compression PMD should be prepared against dpdk-next-crypto repo. + +* For other PMDs and more info, refer to the ``MAINTAINERS`` file. + * New external functions should be added to the local ``version.map`` file. See the :doc:`Guidelines for ABI policy and versioning `. New external functions should also be added in alphabetical order. -- 2.19.2