From: Bagas Sanjaya <bagasdotme@gmail.com>
To: 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>
Cc: 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>,
Bagas Sanjaya <bagasdotme@gmail.com>,
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>
Subject: [PATCH 2/3] Documentation: bpf: Add missing line break separator in node_data struct code block
Date: Wed, 15 Feb 2023 19:32:52 +0700 [thread overview]
Message-ID: <20230215123253.41552-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20230215123253.41552-1-bagasdotme@gmail.com>
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 {
long key;
long data;
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2023-02-15 12:33 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-15 12:32 [PATCH 0/3] Documentation fixes for next-20230215 Bagas Sanjaya
2023-02-15 12:32 ` [PATCH 1/3] Documentation: hw-vuln: Wrap mitigate_smt_rsb example in literal code block Bagas Sanjaya
2023-02-15 12:32 ` Bagas Sanjaya [this message]
2023-02-15 16:46 ` [PATCH 2/3] Documentation: bpf: Add missing line break separator in node_data struct " Alexei Starovoitov
2023-02-15 12:32 ` [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections Bagas Sanjaya
2023-02-15 13:52 ` Wyes Karny
2023-02-15 14:20 ` Huang Rui
2023-02-15 14:59 ` Rafael J. Wysocki
2023-02-15 16:50 ` [PATCH 0/3] Documentation fixes for next-20230215 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=20230215123253.41552-3-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=daniel@iogearbox.net \
--cc=davemarchevsky@fb.com \
--cc=haoluo@google.com \
--cc=john.fastabend@gmail.com \
--cc=jolsa@kernel.org \
--cc=kpsingh@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=lkp@intel.com \
--cc=mario.limonciello@amd.com \
--cc=martin.lau@linux.dev \
--cc=oe-kbuild-all@lists.linux.dev \
--cc=pbonzini@redhat.com \
--cc=perry.yuan@amd.com \
--cc=rafael.j.wysocki@intel.com \
--cc=ray.huang@amd.com \
--cc=sdf@google.com \
--cc=sfr@canb.auug.org.au \
--cc=song@kernel.org \
--cc=thomas.lendacky@amd.com \
--cc=wyes.karny@amd.com \
--cc=yhs@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;
as well as URLs for NNTP newsgroup(s).