From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-f66.google.com (mail-wr1-f66.google.com [209.85.221.66]) by dpdk.org (Postfix) with ESMTP id 49F405B2C; Fri, 12 Apr 2019 12:27:12 +0200 (CEST) Received: by mail-wr1-f66.google.com with SMTP id w1so11250147wrp.2; Fri, 12 Apr 2019 03:27:12 -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=wlJspgdIZ4pF/gQtecsug4m5O8DVTxXW+mX9D2U+b8E=; b=rUGdGDYPF9cddvtNlhrcfuhPq64+G0WY8Elp05lGzWmrtRurxJdkaZQbNVns+CzYBQ p397fjtaFFofAotuMyCgzEwhdWj+AtCheefux6TiGbS5nzeQdZ+9QYHhtaIjjgs7ziIs i1/YJSq40Hfi9WqIt2YvTGtgCTNHUPqLrByw95TKpLbpunoN9qGcZiZE+iyhop2EnO+c r0uTkpHTbz8XdR7YayRO5IWc48vhUBQdUzK36zY8Dd57jCDLUsV9voJDRxBhsa5AnY+m AwQSMLn1ClRtNf1lUW9w4cZ7NCnkSS2yuDfbadF4OfapzLaldrrPCRoYJ5Rku1MW18nW Hj4Q== 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=wlJspgdIZ4pF/gQtecsug4m5O8DVTxXW+mX9D2U+b8E=; b=PD1S6qsv/KI7GUnRso9wQ+HsRoVz+aJZyODyxWCStGwIY/e2FB27enAtKArKCmeZoJ 3KO/t2X6gRH9V3m/Qqsri60ixVP4ZHYc9rRbquf3Mo+Qeie2R1jPgMqUnV/XV3XyO2I2 +jeSDLhk6yNFRGwrdYpV5F8zwUuQwdZcCeqiADOK+xCn1q4iogU3xcAvChAYLhMgva9T cbKRhEUTZKxZZJQ/jSs7TK517YXg/uUPzsZTfVbQispwRWMpU9VTjkW4GTB9fSiiMnGD 0jfgMUm0XF28+GpVfliu2zOesvvi6f+qbi5xcvvhC/3+09s0h4bizspVRNU7FjpkMG6R 82JA== X-Gm-Message-State: APjAAAVfhLWLKegokqBIg2WLk50E1Fx7HVOQOKILZV+0EGVlcTt4GU3c hQ2pAssQfyuMURqgBTwzdjzauo8dJu9f9WZ3 X-Google-Smtp-Source: APXvYqzGEoktWWspkQGAeoOEjQg83z31yPiE+2me4AnXY+Kje3Zxy0Npcw1LSIqHxzXk1oUP6JIfOg== X-Received: by 2002:adf:e50d:: with SMTP id j13mr37236587wrm.165.1555064831865; Fri, 12 Apr 2019 03:27:11 -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 d16sm32761598wrs.68.2019.04.12.03.27.10 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Apr 2019 03:27:11 -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:26:51 +0300 Message-Id: <20190412102651.5855-1-ramirose@gmail.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH V3] 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:27:12 -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 --- V3 changes: * Fix a typo. 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, initial 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 4A2D3A0096 for ; Fri, 12 Apr 2019 12:27:14 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 772C15B2E; Fri, 12 Apr 2019 12:27:13 +0200 (CEST) Received: from mail-wr1-f66.google.com (mail-wr1-f66.google.com [209.85.221.66]) by dpdk.org (Postfix) with ESMTP id 49F405B2C; Fri, 12 Apr 2019 12:27:12 +0200 (CEST) Received: by mail-wr1-f66.google.com with SMTP id w1so11250147wrp.2; Fri, 12 Apr 2019 03:27:12 -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=wlJspgdIZ4pF/gQtecsug4m5O8DVTxXW+mX9D2U+b8E=; b=rUGdGDYPF9cddvtNlhrcfuhPq64+G0WY8Elp05lGzWmrtRurxJdkaZQbNVns+CzYBQ p397fjtaFFofAotuMyCgzEwhdWj+AtCheefux6TiGbS5nzeQdZ+9QYHhtaIjjgs7ziIs i1/YJSq40Hfi9WqIt2YvTGtgCTNHUPqLrByw95TKpLbpunoN9qGcZiZE+iyhop2EnO+c r0uTkpHTbz8XdR7YayRO5IWc48vhUBQdUzK36zY8Dd57jCDLUsV9voJDRxBhsa5AnY+m AwQSMLn1ClRtNf1lUW9w4cZ7NCnkSS2yuDfbadF4OfapzLaldrrPCRoYJ5Rku1MW18nW Hj4Q== 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=wlJspgdIZ4pF/gQtecsug4m5O8DVTxXW+mX9D2U+b8E=; b=PD1S6qsv/KI7GUnRso9wQ+HsRoVz+aJZyODyxWCStGwIY/e2FB27enAtKArKCmeZoJ 3KO/t2X6gRH9V3m/Qqsri60ixVP4ZHYc9rRbquf3Mo+Qeie2R1jPgMqUnV/XV3XyO2I2 +jeSDLhk6yNFRGwrdYpV5F8zwUuQwdZcCeqiADOK+xCn1q4iogU3xcAvChAYLhMgva9T cbKRhEUTZKxZZJQ/jSs7TK517YXg/uUPzsZTfVbQispwRWMpU9VTjkW4GTB9fSiiMnGD 0jfgMUm0XF28+GpVfliu2zOesvvi6f+qbi5xcvvhC/3+09s0h4bizspVRNU7FjpkMG6R 82JA== X-Gm-Message-State: APjAAAVfhLWLKegokqBIg2WLk50E1Fx7HVOQOKILZV+0EGVlcTt4GU3c hQ2pAssQfyuMURqgBTwzdjzauo8dJu9f9WZ3 X-Google-Smtp-Source: APXvYqzGEoktWWspkQGAeoOEjQg83z31yPiE+2me4AnXY+Kje3Zxy0Npcw1LSIqHxzXk1oUP6JIfOg== X-Received: by 2002:adf:e50d:: with SMTP id j13mr37236587wrm.165.1555064831865; Fri, 12 Apr 2019 03:27:11 -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 d16sm32761598wrs.68.2019.04.12.03.27.10 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Apr 2019 03:27:11 -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:26:51 +0300 Message-Id: <20190412102651.5855-1-ramirose@gmail.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH V3] 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: <20190412102651.sK4LXfYnwmIqU2DD23oLO7CCP7NEplJph3HkKXJgFio@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 --- V3 changes: * Fix a typo. 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, initial 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