MIME-Version: 1.0
References: <20230215123253.41552-1-bagasdotme@gmail.com> <20230215123253.41552-3-bagasdotme@gmail.com>
In-Reply-To: <20230215123253.41552-3-bagasdotme@gmail.com>
From:   Alexei Starovoitov <alexei.starovoitov@gmail.com>
Date:   Wed, 15 Feb 2023 08:46:10 -0800
Message-ID: <CAADnVQKZ2rrhrpLMf+cRhmNEQ5rPwFibqUe0eFisL7AkY5_y2A@mail.gmail.com>
Subject: Re: [PATCH 2/3] Documentation: bpf: Add missing line break separator
 in node_data struct code block
To:     Bagas Sanjaya <bagasdotme@gmail.com>
Cc:     Linux Documentation <linux-doc@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Linux Next Mailing List <linux-next@vger.kernel.org>,
        Linux Power Management <linux-pm@vger.kernel.org>,
        Linux BPF Development <bpf@vger.kernel.org>,
        Jonathan Corbet <corbet@lwn.net>,
        Huang Rui <ray.huang@amd.com>,
        Alexei Starovoitov <ast@kernel.org>,
        Daniel Borkmann <daniel@iogearbox.net>,
        Andrii Nakryiko <andrii@kernel.org>,
        Martin KaFai Lau <martin.lau@linux.dev>,
        Song Liu <song@kernel.org>, Yonghong Song <yhs@fb.com>,
        John Fastabend <john.fastabend@gmail.com>,
        KP Singh <kpsingh@kernel.org>,
        Stanislav Fomichev <sdf@google.com>,
        Hao Luo <haoluo@google.com>, Jiri Olsa <jolsa@kernel.org>,
        Paolo Bonzini <pbonzini@redhat.com>,
        Tom Lendacky <thomas.lendacky@amd.com>,
        Dave Marchevsky <davemarchevsky@fb.com>,
        Perry Yuan <perry.yuan@amd.com>,
        "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
        Wyes Karny <wyes.karny@amd.com>,
        Mario Limonciello <mario.limonciello@amd.com>,
        oe-kbuild-all@lists.linux.dev,
        Stephen Rothwell <sfr@canb.auug.org.au>,
        kernel test robot <lkp@intel.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Wed, Feb 15, 2023 at 4:33 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> Stephen Rothwell reported htmldocs warning when merging bpf-next tree,
> which was the same warning as reported by kernel test robot:
>
> Documentation/bpf/graph_ds_impl.rst:62: ERROR: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 12 supplied.
>
> The error is due to Sphinx confuses node_data struct declaration with
> code-block directive option.
>
> Fix the warning by separating the code-block marker with node_data struct
> declaration.
>
> Link: https://lore.kernel.org/linux-next/20230215144505.4751d823@canb.auug.org.au/
> Link: https://lore.kernel.org/linux-doc/202302151123.wUE5FYFx-lkp@intel.com/
> Fixes: c31315c3aa0929 ("bpf, documentation: Add graph documentation for non-owning refs")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/bpf/graph_ds_impl.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/bpf/graph_ds_impl.rst b/Documentation/bpf/graph_ds_impl.rst
> index 8bbf1815efe784..61274622b71d85 100644
> --- a/Documentation/bpf/graph_ds_impl.rst
> +++ b/Documentation/bpf/graph_ds_impl.rst
> @@ -60,6 +60,7 @@ The new-style data structures are intrusive and are defined similarly to their
>  vanilla kernel counterparts:
>
>  .. code-block:: c
> +
>          struct node_data {

Applied to bpf-next.