From patchwork Thu Mar 2 18:39:17 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Vernet X-Patchwork-Id: 63520 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp9733wrd; Thu, 2 Mar 2023 10:40:26 -0800 (PST) X-Google-Smtp-Source: AK7set8Wv4vKxIoafECQvGUDHUUlHQFtJjgfK+wlTsUcTt5QvQVocdLvnSYnmO1WvCtL674b/8Nm X-Received: by 2002:a05:6a20:3d90:b0:cb:cd6a:2e42 with SMTP id s16-20020a056a203d9000b000cbcd6a2e42mr14573833pzi.29.1677782426032; Thu, 02 Mar 2023 10:40:26 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1677782426; cv=none; d=google.com; s=arc-20160816; b=i3Y/57oI5T49uzFI0YPPSlKHIFgTZNBaJbX03EEfzD0Z4vqdZcRWCLG4xpnn6yu4qR OmIcsRVte4eevjqaSRmr7x22QALApGdtChUzv5e7cC6+l3Hc0MqdUhO6gqh1mQnPoe9V WQBfzqOfrzTdWV3iDjo1tgPucNbkqHAUO7S93ZubFloetHKrfW5tAGEvxeNh14Td8wCt xq9AzbdQQZD5UvRruBv/9tthBJoOZ/ZqkdTgySLfnXMj2hdkagPvbiCY1Ho7LG0lFLQc CJ7wYXhQw2pQ6rJSdZos3P7UQct5Jwpt1PC/3wBPgWVApEwn2IdyNE6NU16jtqwlZvkM hefg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from; bh=Xh37jVV18tU4XLWiHUq7/XGNNCrD2HtDOL15WPjQ7Os=; b=YwS2TF6F7+OgXiLjLEP0LhCb7j1/ofrSRx68CFyA7nti3JhTWHD7rVRIb5SiKmzX8T QUZTHIEqCGeAeotlLstCBT1aVse4Y29lgoHCNTE9xQPyLQOy8IY9lHFiF2ymq5u3Thpz NHBVo8HR9I3TRBHKgEJMdHh5KFOIxopAzGr0b215dQUPBKLVDKo0YWkwainJTvWpoihf Ejw26sEudZvSCXf3cdiYqpGPtn+cRlG8O5ZAyN2Yi9lsodKmi3r79APBKSRerIQZaEF2 7IKYwwtx0cVH3r5XW+4OSBZerjvdC+hgJ811ZMq2elxM6c5G0cufm+Ja3Uw4ZpaBVrU0 GQTw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id j71-20020a63804a000000b004df463e1cc2si14926944pgd.793.2023.03.02.10.40.11; Thu, 02 Mar 2023 10:40:26 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229502AbjCBSjY (ORCPT + 99 others); Thu, 2 Mar 2023 13:39:24 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35278 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229455AbjCBSjW (ORCPT ); Thu, 2 Mar 2023 13:39:22 -0500 Received: from mail-qv1-f46.google.com (mail-qv1-f46.google.com [209.85.219.46]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 871D410263; Thu, 2 Mar 2023 10:39:21 -0800 (PST) Received: by mail-qv1-f46.google.com with SMTP id o3so172652qvr.1; Thu, 02 Mar 2023 10:39:21 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1677782360; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=Xh37jVV18tU4XLWiHUq7/XGNNCrD2HtDOL15WPjQ7Os=; b=UsnBUeY4APLvnG5/lRzdQ/TXh9PiHQak3KDRUUCmWER4CPcHySsjncprXkd7S4jdmA 2YeWSlMRTsYlMfUD66uyMKjX2vX5T8MH3dTJi4xd6//DR4R9xeJ2PxPUfY5nx1afQ536 lpmk/AJHwTc3xZA3jrEzMQvAvm1tWoJkCSlFKfpJLs4qksgeWxuhi484scGo98gQQl6w mTqdLpVz4unLadv3BSlnk99H7wc58UxkXZKWQtHxD9fIHOVg9lk3lmAfK6X4ZmPpPol4 rsa/7qZQZou9XrPkqXz+w+JsAU6RYqOtr/YDqfhwZ9XMfdHoMkKmTjdNypUizexGCHjv 7NVg== X-Gm-Message-State: AO0yUKUsA4xGZLKxdUHpIdDH5yaAt6O8+P6YGitcKqt98zwWP3ZOSdWc WBPkLFWeE5mkzGtEAV86zH+504YHga35g+qB X-Received: by 2002:a05:6214:248c:b0:56e:b1d2:9c2a with SMTP id gi12-20020a056214248c00b0056eb1d29c2amr22091937qvb.28.1677782360212; Thu, 02 Mar 2023 10:39:20 -0800 (PST) Received: from localhost ([2620:10d:c091:480::1:5434]) by smtp.gmail.com with ESMTPSA id l19-20020a05620a211300b007423c122457sm150050qkl.63.2023.03.02.10.39.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 02 Mar 2023 10:39:19 -0800 (PST) From: David Vernet To: bpf@vger.kernel.org Cc: ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org, martin.lau@linux.dev, song@kernel.org, yhs@meta.com, john.fastabend@gmail.com, kpsingh@kernel.org, sdf@google.com, haoluo@google.com, jolsa@kernel.org, linux-kernel@vger.kernel.org, kernel-team@meta.com Subject: [PATCH bpf-next 1/2] bpf, docs: Fix link to netdev-FAQ target Date: Thu, 2 Mar 2023 12:39:17 -0600 Message-Id: <20230302183918.54190-1-void@manifault.com> X-Mailer: git-send-email 2.39.0 MIME-Version: 1.0 X-Spam-Status: No, score=-1.4 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS, RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1759282385173350989?= X-GMAIL-MSGID: =?utf-8?q?1759282385173350989?= The BPF devel Q&A documentation page makes frequent reference to the netdev-QA page via the netdev-FAQ rst link. This link is currently broken, as is evidenced by the build output when making BPF docs: ./Documentation/bpf/bpf_devel_QA.rst:150: WARNING: undefined label: 'netdev-faq' ./Documentation/bpf/bpf_devel_QA.rst:206: WARNING: undefined label: 'netdev-faq' ./Documentation/bpf/bpf_devel_QA.rst:231: WARNING: undefined label: 'netdev-faq' ./Documentation/bpf/bpf_devel_QA.rst:396: WARNING: undefined label: 'netdev-faq' ./Documentation/bpf/bpf_devel_QA.rst:412: WARNING: undefined label: 'netdev-faq' Fix the links to point to the actual netdev-faq page. Signed-off-by: David Vernet --- Documentation/bpf/bpf_devel_QA.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst index 03d4993eda6f..5f5f9ccc3862 100644 --- a/Documentation/bpf/bpf_devel_QA.rst +++ b/Documentation/bpf/bpf_devel_QA.rst @@ -128,7 +128,7 @@ into the bpf-next tree will make their way into net-next tree. net and net-next are both run by David S. Miller. From there, they will go into the kernel mainline tree run by Linus Torvalds. To read up on the process of net and net-next being merged into the mainline tree, see -the :ref:`netdev-FAQ` +the `netdev-FAQ`_. @@ -147,7 +147,7 @@ request):: Q: How do I indicate which tree (bpf vs. bpf-next) my patch should be applied to? --------------------------------------------------------------------------------- -A: The process is the very same as described in the :ref:`netdev-FAQ`, +A: The process is the very same as described in the `netdev-FAQ`_, so please read up on it. The subject line must indicate whether the patch is a fix or rather "next-like" content in order to let the maintainers know whether it is targeted at bpf or bpf-next. @@ -206,7 +206,7 @@ ii) run extensive BPF test suite and Once the BPF pull request was accepted by David S. Miller, then the patches end up in net or net-next tree, respectively, and make their way from there further into mainline. Again, see the -:ref:`netdev-FAQ` for additional information e.g. on how often they are +`netdev-FAQ`_ for additional information e.g. on how often they are merged to mainline. Q: How long do I need to wait for feedback on my BPF patches? @@ -230,7 +230,7 @@ Q: Are patches applied to bpf-next when the merge window is open? ----------------------------------------------------------------- A: For the time when the merge window is open, bpf-next will not be processed. This is roughly analogous to net-next patch processing, -so feel free to read up on the :ref:`netdev-FAQ` about further details. +so feel free to read up on the `netdev-FAQ`_ about further details. During those two weeks of merge window, we might ask you to resend your patch series once bpf-next is open again. Once Linus released @@ -394,7 +394,7 @@ netdev kernel mailing list in Cc and ask for the fix to be queued up: netdev@vger.kernel.org The process in general is the same as on netdev itself, see also the -:ref:`netdev-FAQ`. +`netdev-FAQ`_. Q: Do you also backport to kernels not currently maintained as stable? ---------------------------------------------------------------------- @@ -410,7 +410,7 @@ Q: The BPF patch I am about to submit needs to go to stable as well What should I do? A: The same rules apply as with netdev patch submissions in general, see -the :ref:`netdev-FAQ`. +the `netdev-FAQ`_. Never add "``Cc: stable@vger.kernel.org``" to the patch description, but ask the BPF maintainers to queue the patches instead. This can be done @@ -685,7 +685,7 @@ when: .. Links .. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/ -.. _netdev-FAQ: Documentation/process/maintainer-netdev.rst +.. _netdev-FAQ: https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html .. _selftests: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/ .. _Documentation/dev-tools/kselftest.rst: From patchwork Thu Mar 2 18:39:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Vernet X-Patchwork-Id: 63521 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp10966wrd; Thu, 2 Mar 2023 10:43:30 -0800 (PST) X-Google-Smtp-Source: AK7set8kBV9DvAR/pXm/Qe+Jvd0IxOPItOwwCLDB0v5yZpi1oZK/ifT3LtiOVzA+gnsYqD4PhPzm X-Received: by 2002:a17:90b:350f:b0:235:31e9:e793 with SMTP id ls15-20020a17090b350f00b0023531e9e793mr3132689pjb.13.1677782610057; Thu, 02 Mar 2023 10:43:30 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1677782610; cv=none; d=google.com; s=arc-20160816; b=RhkVVtZpeBoygijvYZVJAjoOnwVtOrnpe9aewIohmmX9dQNFj63uDo6Y3HXVi0k5os uUX+4l1tdmDdaGgQWyObbNrTsF1YhGnOcpla0pXjx+s4gCDw+lfuGcuUpZ6e/bzCzTWK SG9iVskgZ/rdOkAU1bp3YycEOCPkLvkoIDTQ/thDSpN3RD3dAoBdsdKT0dzlcccENANt I2ffded15kfl2On4V7Jyhia6XJR4DcwzRY0OlyrC6iSnxnVZY4lnSVafcAeI4qdmy7D7 8gksfG4Jid9Fp2GE3TqQB35doCKvE4AU3so/hNwlOgNhYq5P3UMAAcX543liNjZ30jhn 6q7g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=l9Tp7zR6q1GyOD5xTyxBxaVoqQfeB4d9SNa5DQ/cXfo=; b=JPhRF7FVYUHPxAL9bi84pe3+8wBPQwycGlSrIfmaRC9T1Kdr8zOyCkr6Cl2ciyYcmH s5U22RjtTf1Czq5FFZBQUywJRi24d2lE3T09F8nP9+wWAJvYv8DnZsWHwtf45aOrkSQK oZ4gKcIbL5x8idctjsArpzKqK3UpbJsh+aKQTzMRckjOaU51GqPiREb4SQV89AcCBw0k Dx+GCiLFVin9zlzGTSSaRW0phDXtEYFPIclCsyVAg7DUOIFQ7vTD4OaQ7f8+AyHIOOyH jNPfkidnU/JzxJEjnTJdqpzhs5sz5LEAo60ctevWm5cRuM/GK5E3+8vEvLugSq5xGF5n Ambw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id mu15-20020a17090b388f00b002340e454213si166171pjb.190.2023.03.02.10.43.16; Thu, 02 Mar 2023 10:43:30 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229567AbjCBSj0 (ORCPT + 99 others); Thu, 2 Mar 2023 13:39:26 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35284 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229487AbjCBSjX (ORCPT ); Thu, 2 Mar 2023 13:39:23 -0500 Received: from mail-qt1-f181.google.com (mail-qt1-f181.google.com [209.85.160.181]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0ED5C10A84; Thu, 2 Mar 2023 10:39:23 -0800 (PST) Received: by mail-qt1-f181.google.com with SMTP id r5so284210qtp.4; Thu, 02 Mar 2023 10:39:23 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1677782362; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=l9Tp7zR6q1GyOD5xTyxBxaVoqQfeB4d9SNa5DQ/cXfo=; b=1rDOgWFFX9XIIYIJIF9BRP/O94wmWU1xfXMk1gj6gSl/Q8BWDaTclfnGc5r8wozaOk rZQPTu+fMeDs39SrljuadTEzZAaiKlQS6aH5WOET+619Y7IPmerofIbCcvb6SEdSrDUW frAVCi4UHT6/aHZdNNrAjyKlmisgYq4rkutYHoHxDWTH9WInEKOF2z+r1IIDsS6a/onS HiqZ6A7y9N/yVpDgGw+a6aR1EyQMiF7YP33eMUdwsCLT2TaFEfJr3bAN/GXY9UI4wfH+ kB3ArPeZ4uRG3uyGyhkgWqqgVyL+YhYbDN9o9Bm9Zh4u7KKyMJp210sLkh49ha/01CbX rusw== X-Gm-Message-State: AO0yUKU0o2V5EuxSv7S5d+d0fNZXBlK5ipzurFGuhLgKGMhl6pZhyxo6 uuKgcDBG1nsryjo3Elv5NlpF/yxm5mnx3h6U X-Received: by 2002:ac8:5c88:0:b0:3b8:293c:24eb with SMTP id r8-20020ac85c88000000b003b8293c24ebmr5250856qta.30.1677782361831; Thu, 02 Mar 2023 10:39:21 -0800 (PST) Received: from localhost ([2620:10d:c091:480::1:5434]) by smtp.gmail.com with ESMTPSA id l18-20020ac84592000000b003b9b48cdbe8sm172206qtn.58.2023.03.02.10.39.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 02 Mar 2023 10:39:21 -0800 (PST) From: David Vernet To: bpf@vger.kernel.org Cc: ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org, martin.lau@linux.dev, song@kernel.org, yhs@meta.com, john.fastabend@gmail.com, kpsingh@kernel.org, sdf@google.com, haoluo@google.com, jolsa@kernel.org, linux-kernel@vger.kernel.org, kernel-team@meta.com Subject: [PATCH bpf-next 2/2] bpf, docs: Fix final bpf docs build failure Date: Thu, 2 Mar 2023 12:39:18 -0600 Message-Id: <20230302183918.54190-2-void@manifault.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230302183918.54190-1-void@manifault.com> References: <20230302183918.54190-1-void@manifault.com> MIME-Version: 1.0 X-Spam-Status: No, score=-1.4 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS, RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE, SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1759282578452809351?= X-GMAIL-MSGID: =?utf-8?q?1759282578452809351?= maps.rst in the BPF documentation links to the /userspace-api/ebpf/syscall document (Documentation/userspace-api/ebpf/syscall.rst). For some reason, if you try to reference the document with :doc:, the docs build emits the following warning: ./Documentation/bpf/maps.rst:13: WARNING: \ unknown document: '/userspace-api/ebpf/syscall' It appears that other places in the docs tree also don't support using :doc:. Elsewhere in the BPF documentation, we just reference the kernel docs page directly. Let's do that here to clean up the last remaining noise in the docs build. Signed-off-by: David Vernet --- Documentation/bpf/maps.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/bpf/maps.rst b/Documentation/bpf/maps.rst index 4906ff0f8382..6f069f3d6f4b 100644 --- a/Documentation/bpf/maps.rst +++ b/Documentation/bpf/maps.rst @@ -11,9 +11,9 @@ maps are accessed from BPF programs via BPF helpers which are documented in the `man-pages`_ for `bpf-helpers(7)`_. BPF maps are accessed from user space via the ``bpf`` syscall, which provides -commands to create maps, lookup elements, update elements and delete -elements. More details of the BPF syscall are available in -:doc:`/userspace-api/ebpf/syscall` and in the `man-pages`_ for `bpf(2)`_. +commands to create maps, lookup elements, update elements and delete elements. +More details of the BPF syscall are available in `ebpf-syscall`_ and in the +`man-pages`_ for `bpf(2)`_. Map Types ========= @@ -79,3 +79,4 @@ Find and delete element by key in a given map using ``attr->map_fd``, .. _man-pages: https://www.kernel.org/doc/man-pages/ .. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html .. _bpf-helpers(7): https://man7.org/linux/man-pages/man7/bpf-helpers.7.html +.. _ebpf-syscall: https://docs.kernel.org/userspace-api/ebpf/syscall.html