All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission
@ 2022-11-14 21:15 Daniel Müller
  2022-11-15 14:40 ` patchwork-bot+netdevbpf
                   ` (2 more replies)
  0 siblings, 3 replies; 6+ messages in thread
From: Daniel Müller @ 2022-11-14 21:15 UTC (permalink / raw)
  To: bpf, ast, andrii, daniel, kafai, kernel-team, quentin, eddyz87; +Cc: deso

This change documents the process for running the BPF CI before
submitting a patch to the upstream mailing list, similar to what happens
if a patch is send to bpf@vger.kernel.org: it builds kernel and
selftests and runs the latter on different architecture (but it notably
does not cover stylistic checks such as cover letter verification).
Running BPF CI this way can help achieve better test coverage ahead of
patch submission than merely running locally (say, using
tools/testing/selftests/bpf/vmtest.sh), as additional architectures may
be covered as well.

Signed-off-by: Daniel Müller <deso@posteo.net>
---
 Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index 761474..08572c7 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -44,6 +44,30 @@ is a guarantee that the reported issue will be overlooked.**
 Submitting patches
 ==================
 
+Q: How do I run BPF CI on my changes before sending them out for review?
+------------------------------------------------------------------------
+A: BPF CI is GitHub based and hosted at https://github.com/kernel-patches/bpf.
+While GitHub also provides a CLI that can be used to accomplish the same
+results, here we focus on the UI based workflow.
+
+The following steps lay out how to start a CI run for your patches:
+- Create a fork of the aforementioned repository in your own account (one time
+  action)
+- Clone the fork locally, check out a new branch tracking either the bpf-next
+  or bpf branch, and apply your to-be-tested patches on top of it
+- Push the local branch to your fork and create a pull request against
+  kernel-patches/bpf's bpf-next_base or bpf_base branch, respectively
+
+Shortly after the pull request has been created, the CI workflow will run. Note
+that capacity is shared with patches submitted upstream being checked and so
+depending on utilization the run can take a while to finish.
+
+Note furthermore that both base branches (bpf-next_base and bpf_base) will be
+updated as patches are pushed to the respective upstream branches they track. As
+such, your patch set will automatically (be attempted to) be rebased as well.
+This behavior can result in a CI run being aborted and restarted with the new
+base line.
+
 Q: To which mailing list do I need to submit my BPF patches?
 ------------------------------------------------------------
 A: Please submit your BPF patches to the bpf kernel mailing list:
-- 
2.30.2


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission
  2022-11-14 21:15 [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission Daniel Müller
@ 2022-11-15 14:40 ` patchwork-bot+netdevbpf
  2022-11-15 20:15 ` Quentin Monnet
  2022-11-16 10:01 ` Akira Yokosawa
  2 siblings, 0 replies; 6+ messages in thread
From: patchwork-bot+netdevbpf @ 2022-11-15 14:40 UTC (permalink / raw)
  To: =?utf-8?q?Daniel_M=C3=BCller_=3Cdeso=40posteo=2Enet=3E?=
  Cc: bpf, ast, andrii, daniel, kafai, kernel-team, quentin, eddyz87

Hello:

This patch was applied to bpf/bpf-next.git (master)
by Daniel Borkmann <daniel@iogearbox.net>:

On Mon, 14 Nov 2022 21:15:01 +0000 you wrote:
> This change documents the process for running the BPF CI before
> submitting a patch to the upstream mailing list, similar to what happens
> if a patch is send to bpf@vger.kernel.org: it builds kernel and
> selftests and runs the latter on different architecture (but it notably
> does not cover stylistic checks such as cover letter verification).
> Running BPF CI this way can help achieve better test coverage ahead of
> patch submission than merely running locally (say, using
> tools/testing/selftests/bpf/vmtest.sh), as additional architectures may
> be covered as well.
> 
> [...]

Here is the summary with links:
  - [bpf-next] docs/bpf: Document how to run CI without patch submission
    https://git.kernel.org/bpf/bpf-next/c/26a9b433cf08

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission
  2022-11-14 21:15 [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission Daniel Müller
  2022-11-15 14:40 ` patchwork-bot+netdevbpf
@ 2022-11-15 20:15 ` Quentin Monnet
  2022-11-16 10:01 ` Akira Yokosawa
  2 siblings, 0 replies; 6+ messages in thread
From: Quentin Monnet @ 2022-11-15 20:15 UTC (permalink / raw)
  To: Daniel Müller; +Cc: bpf, ast, andrii, daniel, kafai, kernel-team, eddyz87

On Mon, 14 Nov 2022 at 21:15, Daniel Müller <deso@posteo.net> wrote:
>
> This change documents the process for running the BPF CI before
> submitting a patch to the upstream mailing list, similar to what happens
> if a patch is send to bpf@vger.kernel.org: it builds kernel and
> selftests and runs the latter on different architecture (but it notably
> does not cover stylistic checks such as cover letter verification).
> Running BPF CI this way can help achieve better test coverage ahead of
> patch submission than merely running locally (say, using
> tools/testing/selftests/bpf/vmtest.sh), as additional architectures may
> be covered as well.
>
> Signed-off-by: Daniel Müller <deso@posteo.net>

Thanks a lot for this!
Quentin

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission
  2022-11-14 21:15 [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission Daniel Müller
  2022-11-15 14:40 ` patchwork-bot+netdevbpf
  2022-11-15 20:15 ` Quentin Monnet
@ 2022-11-16 10:01 ` Akira Yokosawa
  2022-11-16 17:20   ` Daniel Müller
  2 siblings, 1 reply; 6+ messages in thread
From: Akira Yokosawa @ 2022-11-16 10:01 UTC (permalink / raw)
  To: Daniel Müller
  Cc: andrii, ast, bpf, daniel, eddyz87, kafai, kernel-team, quentin,
	Akira Yokosawa

Hi Daniel,

I know this has already been applied, but am seeing new warning msgs
from "make htmldocs" due to this change. Please see inline comment
below.

On Mon, 14 Nov 2022 21:15:01 +0000, Daniel Müller wrote:
> This change documents the process for running the BPF CI before
> submitting a patch to the upstream mailing list, similar to what happens
> if a patch is send to bpf@vger.kernel.org: it builds kernel and
> selftests and runs the latter on different architecture (but it notably
> does not cover stylistic checks such as cover letter verification).
> Running BPF CI this way can help achieve better test coverage ahead of
> patch submission than merely running locally (say, using
> tools/testing/selftests/bpf/vmtest.sh), as additional architectures may
> be covered as well.
> 
> Signed-off-by: Daniel Müller <deso@posteo.net>
> ---
>  Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
> 
> diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
> index 761474..08572c7 100644
> --- a/Documentation/bpf/bpf_devel_QA.rst
> +++ b/Documentation/bpf/bpf_devel_QA.rst
> @@ -44,6 +44,30 @@ is a guarantee that the reported issue will be overlooked.**
>  Submitting patches
>  ==================
>  
> +Q: How do I run BPF CI on my changes before sending them out for review?
> +------------------------------------------------------------------------
> +A: BPF CI is GitHub based and hosted at https://github.com/kernel-patches/bpf.
> +While GitHub also provides a CLI that can be used to accomplish the same
> +results, here we focus on the UI based workflow.
> +
> +The following steps lay out how to start a CI run for your patches:

Lack of a blank line here results in warning msgs from "make htmldocs":

/linux/Documentation/bpf/bpf_devel_QA.rst:55: ERROR: Unexpected indentation.
/linux/Documentation/bpf/bpf_devel_QA.rst:56: WARNING: Block quote ends without a blank line; unexpected unindent.

Can you please fix it?

For your reference, here is a link to reST documentation on bullet lists:

    https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#bullet-lists

        Thanks, Akira

> +- Create a fork of the aforementioned repository in your own account (one time
> +  action)
> +- Clone the fork locally, check out a new branch tracking either the bpf-next
> +  or bpf branch, and apply your to-be-tested patches on top of it
> +- Push the local branch to your fork and create a pull request against
> +  kernel-patches/bpf's bpf-next_base or bpf_base branch, respectively
> +
[...]

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission
  2022-11-16 10:01 ` Akira Yokosawa
@ 2022-11-16 17:20   ` Daniel Müller
  2022-11-17  2:04     ` Akira Yokosawa
  0 siblings, 1 reply; 6+ messages in thread
From: Daniel Müller @ 2022-11-16 17:20 UTC (permalink / raw)
  To: Akira Yokosawa
  Cc: andrii, ast, bpf, daniel, eddyz87, kafai, kernel-team, quentin

Hi Akira,

On Wed, Nov 16, 2022 at 07:01:17PM +0900, Akira Yokosawa wrote:
> I know this has already been applied, but am seeing new warning msgs
> from "make htmldocs" due to this change. Please see inline comment
> below.
> 
> On Mon, 14 Nov 2022 21:15:01 +0000, Daniel Müller wrote:
> > This change documents the process for running the BPF CI before
> > submitting a patch to the upstream mailing list, similar to what happens
> > if a patch is send to bpf@vger.kernel.org: it builds kernel and
> > selftests and runs the latter on different architecture (but it notably
> > does not cover stylistic checks such as cover letter verification).
> > Running BPF CI this way can help achieve better test coverage ahead of
> > patch submission than merely running locally (say, using
> > tools/testing/selftests/bpf/vmtest.sh), as additional architectures may
> > be covered as well.
> > 
> > Signed-off-by: Daniel Müller <deso@posteo.net>
> > ---
> >  Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++
> >  1 file changed, 24 insertions(+)
> > 
> > diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
> > index 761474..08572c7 100644
> > --- a/Documentation/bpf/bpf_devel_QA.rst
> > +++ b/Documentation/bpf/bpf_devel_QA.rst
> > @@ -44,6 +44,30 @@ is a guarantee that the reported issue will be overlooked.**
> >  Submitting patches
> >  ==================
> >  
> > +Q: How do I run BPF CI on my changes before sending them out for review?
> > +------------------------------------------------------------------------
> > +A: BPF CI is GitHub based and hosted at https://github.com/kernel-patches/bpf.
> > +While GitHub also provides a CLI that can be used to accomplish the same
> > +results, here we focus on the UI based workflow.
> > +
> > +The following steps lay out how to start a CI run for your patches:
> 
> Lack of a blank line here results in warning msgs from "make htmldocs":
> 
> /linux/Documentation/bpf/bpf_devel_QA.rst:55: ERROR: Unexpected indentation.
> /linux/Documentation/bpf/bpf_devel_QA.rst:56: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Can you please fix it?
> 
> For your reference, here is a link to reST documentation on bullet lists:
> 
>     https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#bullet-lists
> 
>         Thanks, Akira

Thanks for pointing that out. I had not found any references to this rst file
being included in automated doc generation. Will fix it up.

Daniel

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission
  2022-11-16 17:20   ` Daniel Müller
@ 2022-11-17  2:04     ` Akira Yokosawa
  0 siblings, 0 replies; 6+ messages in thread
From: Akira Yokosawa @ 2022-11-17  2:04 UTC (permalink / raw)
  To: Daniel Müller
  Cc: andrii, ast, bpf, daniel, eddyz87, kafai, kernel-team, quentin,
	Akira Yokosawa

On Wed, 16 Nov 2022 17:20:19 +0000, Daniel Müller wrote:
> Hi Akira,
> 
> On Wed, Nov 16, 2022 at 07:01:17PM +0900, Akira Yokosawa wrote:
>> I know this has already been applied, but am seeing new warning msgs
>> from "make htmldocs" due to this change. Please see inline comment
>> below.
>>
>> On Mon, 14 Nov 2022 21:15:01 +0000, Daniel Müller wrote:
>>> This change documents the process for running the BPF CI before
>>> submitting a patch to the upstream mailing list, similar to what happens
>>> if a patch is send to bpf@vger.kernel.org: it builds kernel and
>>> selftests and runs the latter on different architecture (but it notably
>>> does not cover stylistic checks such as cover letter verification).
>>> Running BPF CI this way can help achieve better test coverage ahead of
>>> patch submission than merely running locally (say, using
>>> tools/testing/selftests/bpf/vmtest.sh), as additional architectures may
>>> be covered as well.
>>>
>>> Signed-off-by: Daniel Müller <deso@posteo.net>
>>> ---
>>>  Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++
>>>  1 file changed, 24 insertions(+)
>>>
>>> diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
>>> index 761474..08572c7 100644
>>> --- a/Documentation/bpf/bpf_devel_QA.rst
>>> +++ b/Documentation/bpf/bpf_devel_QA.rst
>>> @@ -44,6 +44,30 @@ is a guarantee that the reported issue will be overlooked.**
>>>  Submitting patches
>>>  ==================
>>>  
>>> +Q: How do I run BPF CI on my changes before sending them out for review?
>>> +------------------------------------------------------------------------
>>> +A: BPF CI is GitHub based and hosted at https://github.com/kernel-patches/bpf.
>>> +While GitHub also provides a CLI that can be used to accomplish the same
>>> +results, here we focus on the UI based workflow.
>>> +
>>> +The following steps lay out how to start a CI run for your patches:
>>
>> Lack of a blank line here results in warning msgs from "make htmldocs":
>>
>> /linux/Documentation/bpf/bpf_devel_QA.rst:55: ERROR: Unexpected indentation.
>> /linux/Documentation/bpf/bpf_devel_QA.rst:56: WARNING: Block quote ends without a blank line; unexpected unindent.
>>
>> Can you please fix it?
>>
>> For your reference, here is a link to reST documentation on bullet lists:
>>
>>     https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#bullet-lists
>>
>>         Thanks, Akira
> 
> Thanks for pointing that out. I had not found any references to this rst file
> being included in automated doc generation. Will fix it up.

JFYI,

bpf_devel_QA is listed under the toctree directive in Documentation/bpf/faq.rst.

If you failed to enlist a new .rst file in a toctree somewhere, you would see
a complaint from "make htmldocs", in this case:

  Documentation/bpf/bpf_devel_QA.rst: WARNING: document isn't included in any toctree

        Thanks, Akira

> 
> Daniel

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2022-11-17  2:05 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-14 21:15 [PATCH bpf-next] docs/bpf: Document how to run CI without patch submission Daniel Müller
2022-11-15 14:40 ` patchwork-bot+netdevbpf
2022-11-15 20:15 ` Quentin Monnet
2022-11-16 10:01 ` Akira Yokosawa
2022-11-16 17:20   ` Daniel Müller
2022-11-17  2:04     ` Akira Yokosawa

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.