From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D107EC433E6 for ; Fri, 5 Mar 2021 02:51:50 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9E9FA64FDB for ; Fri, 5 Mar 2021 02:51:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229528AbhCECvt (ORCPT ); Thu, 4 Mar 2021 21:51:49 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54252 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229436AbhCECvt (ORCPT ); Thu, 4 Mar 2021 21:51:49 -0500 Received: from mail-lf1-x12c.google.com (mail-lf1-x12c.google.com [IPv6:2a00:1450:4864:20::12c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3FD03C061574; Thu, 4 Mar 2021 18:51:49 -0800 (PST) Received: by mail-lf1-x12c.google.com with SMTP id 18so1099147lff.6; Thu, 04 Mar 2021 18:51:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=OjnEJEa+vxW530VM5nSoy3SNP0gFstYX+DggD9FqR3o=; b=kDfjOvunn4rJQXXIqSvt66SJ6pJpenxqRA9js78/6lY1te5GR6SPpZqdZeKMLLpcOc oqv5Fgx94nU89+iQa8tUZx+kxiDqUze1cdHmzk10A1fkpTYMEzzo/o0FKh7YPgKtlbjJ a/EB0KR3iY6mx5s2mZReTZTKQYw2164tbmisH3uIRhayUvHWQfbqdf7IQ8CDypEVainy Xjdkc6WdpWsbxVkXgLWdwowPi29U0Ie2kUBcoeNJd/X5cnvIM4OMOIDDEJUFNsopDSlD OvTNDpEv4KfxRqrYgsFNykNsFuRn1FgH1G9f5VVKlj04KWr1fihj0yPc9dnoSUOB9ibp YfDg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=OjnEJEa+vxW530VM5nSoy3SNP0gFstYX+DggD9FqR3o=; b=B0TQfQlJQDX3dLLJcfkSfE0uuIe51JmJs/WrpUP5+9WSmiVC4Kglfr6NbeqBhOSbga 5s+j0r2o9PgyGobDUdJkyW70/I+CtIpk19XHIyJxJtEjCxgFuao0R9d7aIaSIOu/e0HM 19t3TCwaVf/Oasyx5BxKs2NhP5t/1RXbcaihHe0+whc79H8UROK7yiRjnu2cjkZL3/IR RXyajqoRHi2wc4WgsfLTcRsBsxjUZVDDCZGyT4jZ31s5yjCTb/0IloUfLAlJ4K5Z/J0B wMWEHOsr4vyLmy6vZ6Olq28fp9kfFPDgahUWibpkntyiYNIhAVAmxWoOEdPtLWn7BkqF 4VJA== X-Gm-Message-State: AOAM530acif8bVscC/Pp9p/VXhpHVQKeZ3iuz0iQiPTzZPYOtSu3paPW L+j4M0G83ZBtovoyRZkVQbbTVw8kY1axvqxiXNc= X-Google-Smtp-Source: ABdhPJwN59ho3oOMO8l+pTawq54uy53wr2ypcPMOYjnAS0mF5vqsgRHCxVx+KY4dxOK+qHDWrlOR7g2wRv6VskGhD0I= X-Received: by 2002:a19:48d2:: with SMTP id v201mr3951154lfa.504.1614912707769; Thu, 04 Mar 2021 18:51:47 -0800 (PST) MIME-Version: 1.0 References: <20210302171947.2268128-1-joe@cilium.io> In-Reply-To: <20210302171947.2268128-1-joe@cilium.io> From: Alexei Starovoitov Date: Thu, 4 Mar 2021 18:51:36 -0800 Message-ID: Subject: Re: [PATCHv2 bpf-next 00/15] Improve BPF syscall command documentation To: Joe Stringer Cc: bpf , linux-man , "open list:DOCUMENTATION" , "Michael Kerrisk (man-pages)" , Alexei Starovoitov , Brian Vazquez , Daniel Borkmann , Daniel Mack , John Fastabend , Petar Penkov , Quentin Monnet , Sean Young , Yonghong Song Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: bpf@vger.kernel.org On Tue, Mar 2, 2021 at 9:20 AM Joe Stringer wrote: > > Rather than tackle everything at once, I have focused in this series on > the syscall commands, "enum bpf_cmd". ... > The eventual goal of this effort would be to extend the kernel UAPI > headers such that each of the categories I had listed above (commands, > maps, progs, hooks) have dedicated documentation in the kernel tree, and > that developers must update the comments in the headers to document the > APIs prior to patch acceptance, and that we could auto-generate the > latest version of the bpf(2) manual pages based on a few static > description sections combined with the dynamically-generated output from > the header. > v2: > * Remove build infrastructure in favor of kernel-doc directives > * Shift userspace-api docs under Documentation/userspace-api/ebpf > * Fix scripts/bpf_doc.py syscall --header (throw unsupported error) > * Improve .gitignore handling of newly autogenerated files Looks great. Applied. Thanks!