BPF List
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: "Daniel Müller" <deso@posteo.net>
Cc: bpf@vger.kernel.org, ast@kernel.org, andrii@kernel.org,
	daniel@iogearbox.net, kafai@fb.com, kernel-team@fb.com,
	Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH bpf-next] bpf/docs: Include blank lines between bullet points in bpf_devel_QA.rst
Date: Thu, 17 Nov 2022 08:38:12 +0900	[thread overview]
Message-ID: <d9dbf747-da63-0fbd-66d2-e5107faf58b4@gmail.com> (raw)
In-Reply-To: <20221116174358.2744613-1-deso@posteo.net>

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
>  

  reply	other threads:[~2022-11-16 23:38 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 [this message]
2022-11-17 15:30 ` patchwork-bot+netdevbpf

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=d9dbf747-da63-0fbd-66d2-e5107faf58b4@gmail.com \
    --to=akiyks@gmail.com \
    --cc=andrii@kernel.org \
    --cc=ast@kernel.org \
    --cc=bpf@vger.kernel.org \
    --cc=daniel@iogearbox.net \
    --cc=deso@posteo.net \
    --cc=kafai@fb.com \
    --cc=kernel-team@fb.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox