[PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Tom Rini]

The previous wording on the paragraph about what branch to use when
submitting patches did not reflect how / when the next branch is
currently used. Reword this to note that master should be used for bug
and regression fixes, always, and that next should be used once it
opens, with -rc2.

Reported-by: Jerome Forissier <jerome.forissier@linaro.org>
Signed-off-by: Tom Rini <trini@konsulko.com>
---
 doc/develop/sending_patches.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
index 3f25b1d0466f..82efb717b179 100644
--- a/doc/develop/sending_patches.rst
+++ b/doc/develop/sending_patches.rst
@@ -74,11 +74,13 @@ General Patch Submission Rules
 
 * Send your patches as plain text messages: no HTML, no MIME, no links, no
   compression, no attachments. Just plain text. The best way the generate
-  patches is by using the ``git format-patch`` command. Please use the
-  ``master`` branch of the mainline U-Boot git repository
-  (``https://source.denx.de/u-boot/u-boot.git``) as reference, unless (usually
-  late in a release cycle) there has been an announcement to use the ``next``
-  branch of this repository instead.
+  patches is by using the ``git format-patch`` command. For a patch that is
+  fixing a bug or regression of some sort, please use the ``master`` branch of
+  the mainline U-Boot git repository
+  (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new
+  features, if the ``next`` branch has been opened (which happens with the
+  release of ``-rc2``) that branch should be used, otherwise ``master`` is
+  acceptable.
 
 * Make sure that your mailer does not mangle the patch by automatic changes
   like wrapping of longer lines etc.
-- 
2.34.1

Re: [PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Quentin Schulz]

Hi Tom,

On 8/26/24 6:39 PM, Tom Rini wrote:
> The previous wording on the paragraph about what branch to use when
> submitting patches did not reflect how / when the next branch is
> currently used. Reword this to note that master should be used for bug
> and regression fixes, always, and that next should be used once it
> opens, with -rc2.
> 
> Reported-by: Jerome Forissier <jerome.forissier@linaro.org>
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
>   doc/develop/sending_patches.rst | 12 +++++++-----
>   1 file changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
> index 3f25b1d0466f..82efb717b179 100644
> --- a/doc/develop/sending_patches.rst
> +++ b/doc/develop/sending_patches.rst
> @@ -74,11 +74,13 @@ General Patch Submission Rules
>   
>   * Send your patches as plain text messages: no HTML, no MIME, no links, no
>     compression, no attachments. Just plain text. The best way the generate
> -  patches is by using the ``git format-patch`` command. Please use the
> -  ``master`` branch of the mainline U-Boot git repository
> -  (``https://source.denx.de/u-boot/u-boot.git``) as reference, unless (usually
> -  late in a release cycle) there has been an announcement to use the ``next``
> -  branch of this repository instead.
> +  patches is by using the ``git format-patch`` command. For a patch that is
> +  fixing a bug or regression of some sort, please use the ``master`` branch of
> +  the mainline U-Boot git repository
> +  (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new

Please also remove the tick quotes around the link, it means we cannot 
click on it anymore as it's basically "verbatim". Maybe in a separate patch?

Looks good to me otherwise,

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin

[PATCH] doc/develop/sending_patches.rst: Reword where our git tree is slightly

[Tom Rini]

We shouldn't have had the link to our git tree be contained within "``"
as that meant that it did not work as a link, so remove those. And
rather than make this a link plus text, keep this as a link within the
text for overall clarity.

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Tom Rini <trini@konsulko.com>
---
 doc/develop/sending_patches.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
index 82efb717b179..990cb9912a92 100644
--- a/doc/develop/sending_patches.rst
+++ b/doc/develop/sending_patches.rst
@@ -76,11 +76,10 @@ General Patch Submission Rules
   compression, no attachments. Just plain text. The best way the generate
   patches is by using the ``git format-patch`` command. For a patch that is
   fixing a bug or regression of some sort, please use the ``master`` branch of
-  the mainline U-Boot git repository
-  (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new
-  features, if the ``next`` branch has been opened (which happens with the
-  release of ``-rc2``) that branch should be used, otherwise ``master`` is
-  acceptable.
+  the mainline U-Boot git repository located at
+  https://source.denx.de/u-boot/u-boot.git as reference. For new features, if
+  the ``next`` branch has been opened (which happens with the release of
+  ``-rc2``) that branch should be used, otherwise ``master`` is acceptable.
 
 * Make sure that your mailer does not mangle the patch by automatic changes
   like wrapping of longer lines etc.
-- 
2.34.1

Re: [PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Jerome Forissier]

On 8/26/24 18:39, Tom Rini wrote:
> The previous wording on the paragraph about what branch to use when
> submitting patches did not reflect how / when the next branch is
> currently used. Reword this to note that master should be used for bug
> and regression fixes, always, and that next should be used once it
> opens, with -rc2.
> 
> Reported-by: Jerome Forissier <jerome.forissier@linaro.org>
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
>  doc/develop/sending_patches.rst | 12 +++++++-----
>  1 file changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
> index 3f25b1d0466f..82efb717b179 100644
> --- a/doc/develop/sending_patches.rst
> +++ b/doc/develop/sending_patches.rst
> @@ -74,11 +74,13 @@ General Patch Submission Rules
>  
>  * Send your patches as plain text messages: no HTML, no MIME, no links, no
>    compression, no attachments. Just plain text. The best way the generate
> -  patches is by using the ``git format-patch`` command. Please use the
> -  ``master`` branch of the mainline U-Boot git repository
> -  (``https://source.denx.de/u-boot/u-boot.git``) as reference, unless (usually
> -  late in a release cycle) there has been an announcement to use the ``next``
> -  branch of this repository instead.
> +  patches is by using the ``git format-patch`` command. For a patch that is
> +  fixing a bug or regression of some sort, please use the ``master`` branch of
> +  the mainline U-Boot git repository
> +  (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new
> +  features, if the ``next`` branch has been opened (which happens with the
> +  release of ``-rc2``) that branch should be used, otherwise ``master`` is
> +  acceptable.
>  
>  * Make sure that your mailer does not mangle the patch by automatic changes
>    like wrapping of longer lines etc.

Crystal clear! Thanks.
FWIW and with Quentin's comment about the back ticks addressed or not:

Acked-by: Jerome Forissier <jerome.forissier@linaro.org>

-- 
Jerome

Re: [PATCH] doc/develop/sending_patches.rst: Reword where our git tree is slightly

[Quentin Schulz]

Hi Tom,

On 8/26/24 7:01 PM, Tom Rini wrote:
> We shouldn't have had the link to our git tree be contained within "``"
> as that meant that it did not work as a link, so remove those. And
> rather than make this a link plus text, keep this as a link within the
> text for overall clarity.
> 
> Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin

Re: [PATCH] doc/develop/sending_patches.rst: Reword where our git tree is slightly

[neil.armstrong]

On 26/08/2024 19:01, Tom Rini wrote:
> We shouldn't have had the link to our git tree be contained within "``"
> as that meant that it did not work as a link, so remove those. And
> rather than make this a link plus text, keep this as a link within the
> text for overall clarity.
> 
> Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
>   doc/develop/sending_patches.rst | 9 ++++-----
>   1 file changed, 4 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
> index 82efb717b179..990cb9912a92 100644
> --- a/doc/develop/sending_patches.rst
> +++ b/doc/develop/sending_patches.rst
> @@ -76,11 +76,10 @@ General Patch Submission Rules
>     compression, no attachments. Just plain text. The best way the generate
>     patches is by using the ``git format-patch`` command. For a patch that is
>     fixing a bug or regression of some sort, please use the ``master`` branch of
> -  the mainline U-Boot git repository
> -  (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new
> -  features, if the ``next`` branch has been opened (which happens with the
> -  release of ``-rc2``) that branch should be used, otherwise ``master`` is
> -  acceptable.
> +  the mainline U-Boot git repository located at
> +  https://source.denx.de/u-boot/u-boot.git as reference. For new features, if
> +  the ``next`` branch has been opened (which happens with the release of
> +  ``-rc2``) that branch should be used, otherwise ``master`` is acceptable.
>   
>   * Make sure that your mailer does not mangle the patch by automatic changes
>     like wrapping of longer lines etc.

Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>

Re: [PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Heinrich Schuchardt]

On 8/26/24 18:39, Tom Rini wrote:
> The previous wording on the paragraph about what branch to use when
> submitting patches did not reflect how / when the next branch is
> currently used. Reword this to note that master should be used for bug
> and regression fixes, always, and that next should be used once it
> opens, with -rc2.
>
> Reported-by: Jerome Forissier <jerome.forissier@linaro.org>
> Signed-off-by: Tom Rini <trini@konsulko.com>

Hello Tom,

I missed that patch in my recent documentation pull-request.

Maybe you just want to add it to master with whatever comes next.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> ---
>   doc/develop/sending_patches.rst | 12 +++++++-----
>   1 file changed, 7 insertions(+), 5 deletions(-)
>
> diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
> index 3f25b1d0466f..82efb717b179 100644
> --- a/doc/develop/sending_patches.rst
> +++ b/doc/develop/sending_patches.rst
> @@ -74,11 +74,13 @@ General Patch Submission Rules
>
>   * Send your patches as plain text messages: no HTML, no MIME, no links, no
>     compression, no attachments. Just plain text. The best way the generate
> -  patches is by using the ``git format-patch`` command. Please use the
> -  ``master`` branch of the mainline U-Boot git repository
> -  (``https://source.denx.de/u-boot/u-boot.git``) as reference, unless (usually
> -  late in a release cycle) there has been an announcement to use the ``next``
> -  branch of this repository instead.
> +  patches is by using the ``git format-patch`` command. For a patch that is
> +  fixing a bug or regression of some sort, please use the ``master`` branch of
> +  the mainline U-Boot git repository
> +  (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new
> +  features, if the ``next`` branch has been opened (which happens with the
> +  release of ``-rc2``) that branch should be used, otherwise ``master`` is
> +  acceptable.
>
>   * Make sure that your mailer does not mangle the patch by automatic changes
>     like wrapping of longer lines etc.

Re: [PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 794 bytes --]

On Sun, Sep 15, 2024 at 07:00:08PM +0200, Heinrich Schuchardt wrote:
> On 8/26/24 18:39, Tom Rini wrote:
> > The previous wording on the paragraph about what branch to use when
> > submitting patches did not reflect how / when the next branch is
> > currently used. Reword this to note that master should be used for bug
> > and regression fixes, always, and that next should be used once it
> > opens, with -rc2.
> > 
> > Reported-by: Jerome Forissier <jerome.forissier@linaro.org>
> > Signed-off-by: Tom Rini <trini@konsulko.com>
> 
> Hello Tom,
> 
> I missed that patch in my recent documentation pull-request.
> 
> Maybe you just want to add it to master with whatever comes next.
> 
> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Will do, thanks.

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 1223 bytes --]

On Sun, Sep 15, 2024 at 12:19:29PM -0600, Tom Rini wrote:
> On Sun, Sep 15, 2024 at 07:00:08PM +0200, Heinrich Schuchardt wrote:
> > On 8/26/24 18:39, Tom Rini wrote:
> > > The previous wording on the paragraph about what branch to use when
> > > submitting patches did not reflect how / when the next branch is
> > > currently used. Reword this to note that master should be used for bug
> > > and regression fixes, always, and that next should be used once it
> > > opens, with -rc2.
> > > 
> > > Reported-by: Jerome Forissier <jerome.forissier@linaro.org>
> > > Signed-off-by: Tom Rini <trini@konsulko.com>
> > 
> > Hello Tom,
> > 
> > I missed that patch in my recent documentation pull-request.
> > 
> > Maybe you just want to add it to master with whatever comes next.
> > 
> > Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> 
> Will do, thanks.

You got it already:
commit 85deb7f69ca4467cf5cf75545b253f9414908222
Author:     Tom Rini <trini@konsulko.com>
AuthorDate: Mon Aug 26 10:39:17 2024 -0600
Commit:     Heinrich Schuchardt <xypron.glpk@gmx.de>
CommitDate: Thu Sep 12 18:13:52 2024 +0200

    doc/develop/sending_patches.rst: Clarify when to use which branch

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 907 bytes --]

On Sun, Sep 15, 2024 at 07:00:08PM +0200, Heinrich Schuchardt wrote:
> On 8/26/24 18:39, Tom Rini wrote:
> > The previous wording on the paragraph about what branch to use when
> > submitting patches did not reflect how / when the next branch is
> > currently used. Reword this to note that master should be used for bug
> > and regression fixes, always, and that next should be used once it
> > opens, with -rc2.
> > 
> > Reported-by: Jerome Forissier <jerome.forissier@linaro.org>
> > Signed-off-by: Tom Rini <trini@konsulko.com>
> 
> Hello Tom,
> 
> I missed that patch in my recent documentation pull-request.
> 
> Maybe you just want to add it to master with whatever comes next.
> 
> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Ah, I think you meant to reply to:
https://patchwork.ozlabs.org/project/uboot/patch/20240826170140.2791128-1-trini@konsulko.com/

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: (subset) [PATCH] doc/develop/sending_patches.rst: Clarify when to use which branch

[Tom Rini]

On Mon, 26 Aug 2024 10:39:17 -0600, Tom Rini wrote:

> The previous wording on the paragraph about what branch to use when
> submitting patches did not reflect how / when the next branch is
> currently used. Reword this to note that master should be used for bug
> and regression fixes, always, and that next should be used once it
> opens, with -rc2.
> 
> 
> [...]

Applied to u-boot/master, thanks!

-- 
Tom