| Message ID | 20221116174358.2744613-1-deso@posteo.net (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 383f1a8df8faba88a3bafaddc02f59421bad6829 |
| Delegated to: | BPF |
| Headers | show |
| Series | [bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst | expand |
Hi Daniel, On Wed, 16 Nov 2022 17:43:58 +0000, Daniel Müller wrote: > Commit 26a9b433cf08 ("bpf/docs: Document how to run CI without patch > submission") caused a warning to be generated when compiling the > documentation: > > bpf_devel_QA.rst:55: WARNING: Unexpected indentation. > > bpf_devel_QA.rst:56: WARNING: Block quote ends without a blank line > > This change fixes the problem by inserting the required blank lines. > > Fixes: 26a9b433cf08 ("bpf/docs: Document how to run CI without patch submission") > Reported-by: Akira Yokosawa <akiyks@gmail.com> > Signed-off-by: Daniel Müller <deso@posteo.net> > --- > Documentation/bpf/bpf_devel_QA.rst | 3 +++ > 1 file changed, 3 insertions(+) > > diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst > index 08572c7..03d499 100644 > --- a/Documentation/bpf/bpf_devel_QA.rst > +++ b/Documentation/bpf/bpf_devel_QA.rst > @@ -51,10 +51,13 @@ 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) > + To be clear, as is mentioned in the reST documentation (quoted below): - This is the first bullet list item. The blank line above the first list item is required; blank lines between list items (such as below this paragraph) are optional. , this and next blank lines are not required but optional. Either way, Reviewed-by: Akira Yokosawa <akiyks@gmail.com> > - 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 >
Hello: This patch was applied to bpf/bpf-next.git (master) by Daniel Borkmann <daniel@iogearbox.net>: On Wed, 16 Nov 2022 17:43:58 +0000 you wrote: > Commit 26a9b433cf08 ("bpf/docs: Document how to run CI without patch > submission") caused a warning to be generated when compiling the > documentation: > > bpf_devel_QA.rst:55: WARNING: Unexpected indentation. > > bpf_devel_QA.rst:56: WARNING: Block quote ends without a blank line > > This change fixes the problem by inserting the required blank lines. > > [...] Here is the summary with links: - [bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst https://git.kernel.org/bpf/bpf-next/c/383f1a8df8fa You are awesome, thank you!
diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst index 08572c7..03d499 100644 --- a/Documentation/bpf/bpf_devel_QA.rst +++ b/Documentation/bpf/bpf_devel_QA.rst @@ -51,10 +51,13 @@ 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
Commit 26a9b433cf08 ("bpf/docs: Document how to run CI without patch submission") caused a warning to be generated when compiling the documentation: > bpf_devel_QA.rst:55: WARNING: Unexpected indentation. > bpf_devel_QA.rst:56: WARNING: Block quote ends without a blank line This change fixes the problem by inserting the required blank lines. Fixes: 26a9b433cf08 ("bpf/docs: Document how to run CI without patch submission") Reported-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Daniel Müller <deso@posteo.net> --- Documentation/bpf/bpf_devel_QA.rst | 3 +++ 1 file changed, 3 insertions(+)