BPF List
 help / color / mirror / Atom feed
* [PATCH bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst
@ 2022-11-16 17:43 Daniel Müller
  2022-11-16 23:38 ` Akira Yokosawa
  2022-11-17 15:30 ` patchwork-bot+netdevbpf
  0 siblings, 2 replies; 3+ messages in thread
From: Daniel Müller @ 2022-11-16 17:43 UTC (permalink / raw)
  To: bpf, ast, andrii, daniel, kafai, kernel-team; +Cc: deso, Akira Yokosawa

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)
+
 - 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
 
-- 
2.30.2


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

* Re: [PATCH bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst
  2022-11-16 17:43 [PATCH bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst Daniel Müller
@ 2022-11-16 23:38 ` Akira Yokosawa
  2022-11-17 15:30 ` patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: Akira Yokosawa @ 2022-11-16 23:38 UTC (permalink / raw)
  To: Daniel Müller
  Cc: bpf, ast, andrii, daniel, kafai, kernel-team, Akira Yokosawa

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
>  

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

* Re: [PATCH bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst
  2022-11-16 17:43 [PATCH bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst Daniel Müller
  2022-11-16 23:38 ` Akira Yokosawa
@ 2022-11-17 15:30 ` patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: patchwork-bot+netdevbpf @ 2022-11-17 15:30 UTC (permalink / raw)
  To: =?utf-8?q?Daniel_M=C3=BCller_=3Cdeso=40posteo=2Enet=3E?=
  Cc: bpf, ast, andrii, daniel, kafai, kernel-team, akiyks

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!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



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

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

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-11-16 17:43 [PATCH bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst Daniel Müller
2022-11-16 23:38 ` Akira Yokosawa
2022-11-17 15:30 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox