[bpf-next,5/5] bpf/docs: Update documentation for new cpumask kfuncs

Message ID 20230610035053.117605-5-void@manifault.com
State New
Headers
Series [bpf-next,1/5] bpf: Add bpf_cpumask_first_and() kfunc |

Commit Message

David Vernet June 10, 2023, 3:50 a.m. UTC
  We recently added the bpf_cpumask_first_and() kfunc, and changed
bpf_cpumask_any() / bpf_cpumask_any_and() to
bpf_cpumask_any_distribute() and bpf_cpumask_any_distribute_and()
respectively. This patch adds an entry for the bpf_cpumask_first_and()
kfunc, and updates the documentation for the *any* kfuncs to the new
names.

Signed-off-by: David Vernet <void@manifault.com>
---
 Documentation/bpf/cpumasks.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
  

Comments

Yonghong Song June 12, 2023, 3:23 p.m. UTC | #1
On 6/9/23 8:50 PM, David Vernet wrote:
> We recently added the bpf_cpumask_first_and() kfunc, and changed
> bpf_cpumask_any() / bpf_cpumask_any_and() to
> bpf_cpumask_any_distribute() and bpf_cpumask_any_distribute_and()
> respectively. This patch adds an entry for the bpf_cpumask_first_and()
> kfunc, and updates the documentation for the *any* kfuncs to the new
> names.
> 
> Signed-off-by: David Vernet <void@manifault.com>

Acked-by: Yonghong Song <yhs@fb.com>
  

Patch

diff --git a/Documentation/bpf/cpumasks.rst b/Documentation/bpf/cpumasks.rst
index 41efd8874eeb..3139c7c02e79 100644
--- a/Documentation/bpf/cpumasks.rst
+++ b/Documentation/bpf/cpumasks.rst
@@ -351,14 +351,15 @@  In addition to the above kfuncs, there is also a set of read-only kfuncs that
 can be used to query the contents of cpumasks.
 
 .. kernel-doc:: kernel/bpf/cpumask.c
-   :identifiers: bpf_cpumask_first bpf_cpumask_first_zero bpf_cpumask_test_cpu
+   :identifiers: bpf_cpumask_first bpf_cpumask_first_zero bpf_cpumask_first_and
+                 bpf_cpumask_test_cpu
 
 .. kernel-doc:: kernel/bpf/cpumask.c
    :identifiers: bpf_cpumask_equal bpf_cpumask_intersects bpf_cpumask_subset
                  bpf_cpumask_empty bpf_cpumask_full
 
 .. kernel-doc:: kernel/bpf/cpumask.c
-   :identifiers: bpf_cpumask_any bpf_cpumask_any_and
+   :identifiers: bpf_cpumask_any_distribute bpf_cpumask_any_and_distribute
 
 ----