[PATCH] docs: submitting-patches: Advertise b4

[PATCH] docs: submitting-patches: Advertise b4

[Mark Brown]

b4 is now widely used and is quite helpful for a lot of the things that
submitting-patches covers, let's advertise it to submitters to try to make
their lives easier and reduce the number of procedural issues maintainers
see.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
 Documentation/process/submitting-patches.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index f310f2f36666..4b6904184ad1 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -842,6 +842,16 @@ Make sure that base commit is in an official maintainer/mainline tree
 and not in some internal, accessible only to you tree - otherwise it
 would be worthless.
 
+
+Tooling
+-------
+
+Many of the technical aspects of this process can be automated using
+b4, documented at <https://b4.docs.kernel.org/en/latest/>. This can
+help with things like tracking dependencies, running checkpatch and
+with formatting and sending mails.
+
+
 References
 ----------
 

---
base-commit: 7c626ce4bae1ac14f60076d00eafe71af30450ba
change-id: 20240903-documentation-b4-advert-18016e83d7d9

Best regards,
-- 
Mark Brown <broonie@kernel.org>

Re: [PATCH] docs: submitting-patches: Advertise b4

[Mauro Carvalho Chehab]

Em Tue, 03 Sep 2024 23:42:04 +0100
Mark Brown <broonie@kernel.org> escreveu:

> b4 is now widely used and is quite helpful for a lot of the things that
> submitting-patches covers, let's advertise it to submitters to try to make
> their lives easier and reduce the number of procedural issues maintainers
> see.
> 
> Signed-off-by: Mark Brown <broonie@kernel.org>
> ---
>  Documentation/process/submitting-patches.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index f310f2f36666..4b6904184ad1 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -842,6 +842,16 @@ Make sure that base commit is in an official maintainer/mainline tree
>  and not in some internal, accessible only to you tree - otherwise it
>  would be worthless.
>  
> +
> +Tooling
> +-------
> +
> +Many of the technical aspects of this process can be automated using
> +b4, documented at <https://b4.docs.kernel.org/en/latest/>. This can
> +help with things like tracking dependencies, running checkpatch and
> +with formatting and sending mails.
> +
> +

No need for two blank lines (yeah, there's a mix on this file of using
one or two blank lines for paragraphs).

I would also add quick example(s) on how to use it for common workflows.

>  References
>  ----------
>  
> 
> ---
> base-commit: 7c626ce4bae1ac14f60076d00eafe71af30450ba
> change-id: 20240903-documentation-b4-advert-18016e83d7d9
> 
> Best regards,



Thanks,
Mauro

Re: [PATCH] docs: submitting-patches: Advertise b4

[Mark Brown]

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

On Wed, Sep 04, 2024 at 04:44:51AM +0200, Mauro Carvalho Chehab wrote:
> Mark Brown <broonie@kernel.org> escreveu:

> > +Tooling
> > +-------

> > +Many of the technical aspects of this process can be automated using
> > +b4, documented at <https://b4.docs.kernel.org/en/latest/>. This can
> > +help with things like tracking dependencies, running checkpatch and
> > +with formatting and sending mails.
> > +
> > +

> No need for two blank lines (yeah, there's a mix on this file of using
> one or two blank lines for paragraphs).

I have to say that the double lines between sections do help with
native readability of the document.

> I would also add quick example(s) on how to use it for common workflows.

The b4 documentation is already pretty good and the submitter side is
focused on a single task so it's much easier for people to navigate
than something like git where there's a lot of flexibility, I'm not sure
rewriting an abbreviated version is a great idea.  Someone with a better
idea of what would be useful could always follow up and add that.

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

[PATCH] docs: submitting-patches: Advertise b4

[Mark Brown]

b4 is now widely used and is quite helpful for a lot of the things that
submitting-patches covers, let's advertise it to submitters to try to make
their lives easier and reduce the number of procedural issues maintainers
see.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
 Documentation/process/submitting-patches.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index f310f2f36666..4b6904184ad1 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -842,6 +842,16 @@ Make sure that base commit is in an official maintainer/mainline tree
 and not in some internal, accessible only to you tree - otherwise it
 would be worthless.
 
+
+Tooling
+-------
+
+Many of the technical aspects of this process can be automated using
+b4, documented at <https://b4.docs.kernel.org/en/latest/>. This can
+help with things like tracking dependencies, running checkpatch and
+with formatting and sending mails.
+
+
 References
 ----------
 

---
base-commit: 7c626ce4bae1ac14f60076d00eafe71af30450ba
change-id: 20240903-documentation-b4-advert-18016e83d7d9

Best regards,
-- 
Mark Brown <broonie@kernel.org>

[PATCH] docs: submitting-patches: Advertise b4

[Mark Brown]

b4 is now widely used and is quite helpful for a lot of the things that
submitting-patches covers, let's advertise it to submitters to try to make
their lives easier and reduce the number of procedural issues maintainers
see.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
 Documentation/process/submitting-patches.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index f310f2f36666..4b6904184ad1 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -842,6 +842,16 @@ Make sure that base commit is in an official maintainer/mainline tree
 and not in some internal, accessible only to you tree - otherwise it
 would be worthless.
 
+
+Tooling
+-------
+
+Many of the technical aspects of this process can be automated using
+b4, documented at <https://b4.docs.kernel.org/en/latest/>. This can
+help with things like tracking dependencies, running checkpatch and
+with formatting and sending mails.
+
+
 References
 ----------
 

---
base-commit: 7c626ce4bae1ac14f60076d00eafe71af30450ba
change-id: 20240903-documentation-b4-advert-18016e83d7d9

Best regards,
-- 
Mark Brown <broonie@kernel.org>

Re: [PATCH] docs: submitting-patches: Advertise b4

[Shuah Khan]

On 9/3/24 16:36, Mark Brown wrote:
> b4 is now widely used and is quite helpful for a lot of the things that
> submitting-patches covers, let's advertise it to submitters to try to make
> their lives easier and reduce the number of procedural issues maintainers
> see.
> 
> Signed-off-by: Mark Brown <broonie@kernel.org>
> ---
>   Documentation/process/submitting-patches.rst | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index f310f2f36666..4b6904184ad1 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -842,6 +842,16 @@ Make sure that base commit is in an official maintainer/mainline tree
>   and not in some internal, accessible only to you tree - otherwise it
>   would be worthless.
>   
> +
> +Tooling
> +-------
> +
> +Many of the technical aspects of this process can be automated using
> +b4, documented at <https://b4.docs.kernel.org/en/latest/>. This can
> +help with things like tracking dependencies, running checkpatch and
> +with formatting and sending mails.
> +
> +
>   References
>   ----------
>   
> 
> ---
> base-commit: 7c626ce4bae1ac14f60076d00eafe71af30450ba
> change-id: 20240903-documentation-b4-advert-18016e83d7d9
> 
> Best regards,

Looks good to me. Thanks for the update.

Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>

thanks,
-- Shuah