Netdev List
 help / color / mirror / Atom feed
From: Markus Heiser <markus.heiser@darmarit.de>
To: Daniel Borkmann <daniel@iogearbox.net>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Quentin Monnet <quentin.monnet@netronome.com>,
	ast@kernel.org, netdev@vger.kernel.org,
	oss-drivers@netronome.com,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-man@vger.kernel.org
Subject: Re: [RFC bpf-next] bpf: document eBPF helpers and add a script to generate man page
Date: Mon, 9 Apr 2018 11:35:25 +0200	[thread overview]
Message-ID: <C6491E01-3FC2-4AC4-8190-7B17CFAC01AD@darmarit.de> (raw)
In-Reply-To: <81150b4e-79d5-f837-72bc-d988e87f842a@iogearbox.net>


> Am 09.04.2018 um 11:25 schrieb Daniel Borkmann <daniel@iogearbox.net>:
> 
> On 04/09/2018 11:21 AM, Markus Heiser wrote:
> [...]
>> Do we really need another kernel-doc parser?
>> 
>>  ./scripts/kernel-doc include/uapi/linux/bpf.h
>> 
>> should already do the job (producing .rst). For more infos, take a look at
> 
> This has absolutely zero to do with kernel-doc, but rather producing
> a description of BPF helper function that are later assembled into an
> actual man-page that BPF program developers (user space) can use.

May I completely misunderstood you, so correct my if I'am wrong:

- ./scripts/bpf_helpers_doc.py : produces reST markup from C-comments
- ./scripts/kerne-doc          : produces reST markup from C-comments

IMO: both are doing the same job, so why not using kernel-doc?

-- Markus --

  reply	other threads:[~2018-04-09  9:35 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-06 11:11 [RFC bpf-next] bpf: document eBPF helpers and add a script to generate man page Quentin Monnet
2018-04-09  3:48 ` Alexei Starovoitov
2018-04-09  9:01 ` Daniel Borkmann
     [not found]   ` <AB89F6E2-DE8A-4259-B361-BE96AD32E84E@darmarit.de>
2018-04-09  9:25     ` Daniel Borkmann
2018-04-09  9:35       ` Markus Heiser [this message]
2018-04-09 10:08         ` Daniel Borkmann
2018-04-09 10:52           ` Markus Heiser
2018-04-09 13:33             ` Quentin Monnet
2018-04-09  9:26   ` Markus Heiser
2018-04-09 13:25   ` Quentin Monnet
2018-04-10  1:47     ` Alexei Starovoitov
2018-04-10 10:21       ` Quentin Monnet

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=C6491E01-3FC2-4AC4-8190-7B17CFAC01AD@darmarit.de \
    --to=markus.heiser@darmarit.de \
    --cc=ast@kernel.org \
    --cc=corbet@lwn.net \
    --cc=daniel@iogearbox.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=oss-drivers@netronome.com \
    --cc=quentin.monnet@netronome.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