[dpdk-dev] doc: add sub-repositories information

Message ID 20161110172718.2292-1-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
checkpatch/checkpatch success coding style OK

Commit Message

Ferruh Yigit Nov. 10, 2016, 5:27 p.m. UTC
  DPDK switched to main and sub-repositories approach, this patch
documents new approach and updates development process according.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/guides/contributing/patches.rst | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)
  

Comments

John McNamara Nov. 11, 2016, 10:27 a.m. UTC | #1
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Thursday, November 10, 2016 5:27 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Thomas Monjalon
> <thomas.monjalon@6wind.com>
> Subject: [PATCH] doc: add sub-repositories information
> 
> DPDK switched to main and sub-repositories approach, this patch documents
> new approach and updates development process according.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Shreyansh Jain Nov. 11, 2016, 1:15 p.m. UTC | #2
Hello Ferruh,

Trivial comment/suggestion:

On Thursday 10 November 2016 10:57 PM, Ferruh Yigit wrote:
> DPDK switched to main and sub-repositories approach, this patch
> documents new approach and updates development process according.
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
>  doc/guides/contributing/patches.rst | 18 +++++++++++++++---
>  1 file changed, 15 insertions(+), 3 deletions(-)
>
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index 729aea7..bec9bfc 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -20,7 +20,14 @@ The DPDK development process has the following features:
>  * There is a mailing list where developers submit patches.
>  * There are maintainers for hierarchical components.
>  * Patches are reviewed publicly on the mailing list.
> -* Successfully reviewed patches are merged to the master branch of the repository.
> +* Successfully reviewed patches are merged to the repository.
> +
> +|
> +
> +* There are main repository ``dpdk`` and sub-repositories ``dpdk-next-*``.
> +* A patch should be sent for its target repository. Like net drivers should be on top of dpdk-next-net repository.
> +* All sub-repositories merged into main repository for -rc1 and -rc2 versions of the release.

'All sub-repositories *are* merged into ...'?

> +* After -rc2 release all patches should target main repository.
>
>  The mailing list for DPDK development is `dev@dpdk.org <http://dpdk.org/ml/archives/dev/>`_.
>  Contributors will need to `register for the mailing list <http://dpdk.org/ml/listinfo/dev>`_ in order to submit patches.
> @@ -33,12 +40,17 @@ Refer to the `Pro Git Book <http://www.git-scm.com/book/>`_ for further informat
>  Getting the Source Code
>  -----------------------
>
> -The source code can be cloned using either of the following::
> +The source code can be cloned using either of the following:
>
> -    git clone git://dpdk.org/dpdk
> +main repository::
>
> +    git clone git://dpdk.org/dpdk
>      git clone http://dpdk.org/git/dpdk
>
> +sub-repositories (`list <http://dpdk.org/browse/next>`_)::
> +
> +    git clone git://dpdk.org/next/dpdk-next-*
> +    git clone http://dpdk.org/git/next/dpdk-next-*
>
>  Make your Changes
>  -----------------
>

-
Shreyansh
  
Ferruh Yigit Nov. 11, 2016, 1:16 p.m. UTC | #3
Hi Shreyansh,

On 11/11/2016 1:15 PM, Shreyansh Jain wrote:
>> +* All sub-repositories merged into main repository for -rc1 and -rc2 versions of the release.
> 'All sub-repositories *are* merged into ...'?

I will send a fixed version.

Thanks,
ferruh
  

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 729aea7..bec9bfc 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -20,7 +20,14 @@  The DPDK development process has the following features:
 * There is a mailing list where developers submit patches.
 * There are maintainers for hierarchical components.
 * Patches are reviewed publicly on the mailing list.
-* Successfully reviewed patches are merged to the master branch of the repository.
+* Successfully reviewed patches are merged to the repository.
+
+|
+
+* There are main repository ``dpdk`` and sub-repositories ``dpdk-next-*``.
+* A patch should be sent for its target repository. Like net drivers should be on top of dpdk-next-net repository.
+* All sub-repositories merged into main repository for -rc1 and -rc2 versions of the release.
+* After -rc2 release all patches should target main repository.
 
 The mailing list for DPDK development is `dev@dpdk.org <http://dpdk.org/ml/archives/dev/>`_.
 Contributors will need to `register for the mailing list <http://dpdk.org/ml/listinfo/dev>`_ in order to submit patches.
@@ -33,12 +40,17 @@  Refer to the `Pro Git Book <http://www.git-scm.com/book/>`_ for further informat
 Getting the Source Code
 -----------------------
 
-The source code can be cloned using either of the following::
+The source code can be cloned using either of the following:
 
-    git clone git://dpdk.org/dpdk
+main repository::
 
+    git clone git://dpdk.org/dpdk
     git clone http://dpdk.org/git/dpdk
 
+sub-repositories (`list <http://dpdk.org/browse/next>`_)::
+
+    git clone git://dpdk.org/next/dpdk-next-*
+    git clone http://dpdk.org/git/next/dpdk-next-*
 
 Make your Changes
 -----------------