From: Donald Hunter <donald.hunter@gmail.com>
To: Andrii Nakryiko <andrii.nakryiko@gmail.com>
Cc: "Daniel Müller" <deso@posteo.net>,
"Daniel Borkmann" <daniel@iogearbox.net>,
bpf@vger.kernel.org, linux-doc@vger.kernel.org,
"Jonathan Corbet" <corbet@lwn.net>
Subject: Re: [PATCH bpf-next v3 1/2] Add subdir support to Documentation makefile
Date: Fri, 09 Sep 2022 11:12:22 +0100 [thread overview]
Message-ID: <m2bkro3lh5.fsf@gmail.com> (raw)
In-Reply-To: <CAEf4BzZ_2wCVTjhAe0XzJ5qfbVhV0pfZeJ=z9Jg_fj_fzD1JFw@mail.gmail.com> (Andrii Nakryiko's message of "Thu, 8 Sep 2022 16:29:55 -0700")
Andrii Nakryiko <andrii.nakryiko@gmail.com> writes:
> On Tue, Sep 6, 2022 at 3:50 AM Donald Hunter <donald.hunter@gmail.com> wrote:
>>
>> Daniel Borkmann <daniel@iogearbox.net> writes:
>>
>> > On 8/29/22 11:14 AM, Donald Hunter wrote:
>> >> Run make in list of subdirs to build generated sources and migrate
>> >> userspace-api/media to use this instead of being a special case.
>> >> Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
>> >
>> > Jonathan, given this touches Documentation/Makefile, could you ACK if
>> > it looks good to you? Noticed both patches don't have doc: $subj prefix,
>> > but that's something we could fix up.
>> >
>> > Maybe one small request, would be nice to build Documentation/bpf/libbpf/
>> > also with every BPF CI run to avoid breakage of program_types.csv. Donald
>> > could you check if feasible? Follow-up might be ok too, but up to Andrii.
>>
>> Sure, I can look at what is needed for the BPF CI run.
>>
>
> Daniel (Mueller, not Borkmann), is this something that can be added to BPF CI?
It looks to me like it can be added to BPF CI if we change docs/conf.py
to call a new make target in docs/sphinx/Makefile. Hopefully Daniel can
confirm whether this is the case.
Given that the tree layouts of the kernel and libbpf are very different
I think we need to do one of:
1. Use a separate a .csv generator script with dedicated makefiles per
project.
2. Move this entirely to libbpf and include a readthedocs URL in
index.rst in the same way as currently done for the API docs.
I think my preference would be for 2.
Thanks
Donald.
next prev parent reply other threads:[~2022-09-09 10:14 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-29 9:14 [PATCH bpf-next v3 0/2] Add table of BPF program types to docs Donald Hunter
2022-08-29 9:14 ` [PATCH bpf-next v3 1/2] Add subdir support to Documentation makefile Donald Hunter
2022-09-02 15:08 ` Daniel Borkmann
2022-09-06 10:21 ` Donald Hunter
2022-09-08 23:29 ` Andrii Nakryiko
2022-09-09 10:12 ` Donald Hunter [this message]
2022-09-09 21:49 ` Daniel Müller
2022-09-12 8:31 ` Donald Hunter
2022-08-29 9:15 ` [PATCH bpf-next v3 2/2] Add table of BPF program types to libbpf docs Donald Hunter
2022-09-02 15:42 ` Jani Nikula
2022-09-06 10:49 ` Donald Hunter
2022-09-06 12:31 ` Jani Nikula
2022-09-05 16:48 ` Jesper D. Brouer
2022-09-06 12:32 ` Jani Nikula
2022-09-06 17:07 ` Donald Hunter
2022-09-07 8:13 ` Jani Nikula
2022-09-09 22:24 ` [PATCH bpf-next v3 0/2] Add table of BPF program types to docs Andrii Nakryiko
2022-09-12 8:44 ` Donald Hunter
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=m2bkro3lh5.fsf@gmail.com \
--to=donald.hunter@gmail.com \
--cc=andrii.nakryiko@gmail.com \
--cc=bpf@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=daniel@iogearbox.net \
--cc=deso@posteo.net \
--cc=linux-doc@vger.kernel.org \
/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).