docs/bpf: Document how to run CI without patch submission
Subsystems (2)
PATCH 1/1 docs/bpf: Document how to run CI without patch submission
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 [email protected]: 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.
--- Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)
Documentation/bpf/bpf_devel_QA.rst +24 -0
@@ -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:
Signature · 1 line
2.30.2
This patch was applied to bpf/bpf-next.git (master) by Daniel Borkmann <[email protected]>:
Hello:
This patch was applied to bpf/bpf-next.git (master) by Daniel Borkmann <[email protected]>:
Quoted 11 lines · 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 [email protected]: 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!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html
Quoted 11 lines · Daniel Müller
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 [email protected]: 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.
Quoted 1 line
Signed-off-by Daniel Müller <[email protected]>
Thanks a lot for this!
Quentin
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.
Quoted 20 lines · Daniel Müller
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 [email protected]: 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 <[email protected]>--- Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)Documentation/bpf/bpf_devel_QA.rst +0
-0
Documentation/bpf/bpf_devel_QA.rst is a guarantee that the reported issue will be overlooked.** · line 53
Quoted 10 lines
Documentation/bpf/bpf_devel_QA.rst +7
-0@@ -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
Quoted 7 lines
Documentation/bpf/bpf_devel_QA.rst +7
-0+- 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 +
[...]
Hi Akira,
Quoted 41 lines · Akira Yokosawa
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.
Quoted 20 lines · Daniel Müller
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 [email protected]: 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 <[email protected]>--- Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)Documentation/bpf/bpf_devel_QA.rst +0
-0Documentation/bpf/bpf_devel_QA.rst is a guarantee that the reported issue will be overlooked.** · line 53
Quoted 10 lines
Documentation/bpf/bpf_devel_QA.rst +7
-0@@ -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.
Quoted 7 lines
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
Quoted 46 lines · Daniel Müller
Hi Akira,
Quoted 43 lines · Akira Yokosawa
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.
Quoted 20 lines · Daniel Müller
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 [email protected]: 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 <[email protected]>--- Documentation/bpf/bpf_devel_QA.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)Documentation/bpf/bpf_devel_QA.rst +0
-0Documentation/bpf/bpf_devel_QA.rst is a guarantee that the reported issue will be overlooked.** · line 53
Quoted 10 lines
Documentation/bpf/bpf_devel_QA.rst +7
-0@@ -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?
Quoted 8 lines
Quoted 5 lines
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
Quoted 2 lines
Daniel