diff mbox series

[v3,14/23] bpftool: update bpftool-cgroup.rst reference

Message ID 11f3dc3cfc192e2ee271467d7a6c7c1920006766.1634630486.git.mchehab+huawei@kernel.org (mailing list archive)
State New
Headers show
Series Fix some issues at documentation | expand

Commit Message

Mauro Carvalho Chehab Oct. 19, 2021, 8:04 a.m. UTC
The file name: Documentation/bpftool-cgroup.rst
should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.

Update its cross-reference accordingly.

Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
Fixes: 5ccda64d38cc ("bpftool: implement cgroup bpf operations")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

To mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/

 tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Quentin Monnet Oct. 19, 2021, 9:35 a.m. UTC | #1
2021-10-19 09:04 UTC+0100 ~ Mauro Carvalho Chehab
<mchehab+huawei@kernel.org>
> The file name: Documentation/bpftool-cgroup.rst
> should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.
> 
> Update its cross-reference accordingly.
> 
> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
> Fixes: 5ccda64d38cc ("bpftool: implement cgroup bpf operations")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> 
> To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/
> 
>  tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> index be54b7335a76..617b8084c440 100755
> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> @@ -392,7 +392,7 @@ class ManCgroupExtractor(ManPageExtractor):
>      """
>      An extractor for bpftool-cgroup.rst.
>      """
> -    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-cgroup.rst')
> +    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-cgroup.rst')
>  
>      def get_attach_types(self):
>          return self.get_rst_list('ATTACH_TYPE')
> 

No, this change is incorrect. We have discussed it several times before
[0][1]. Please drop this patch.

Quentin

[0]
https://lore.kernel.org/bpf/eb80e8f5-b9d7-5031-8ebb-4595bb295dbf@isovalent.com/
[1]
https://lore.kernel.org/bpf/CAEf4BzZhr+3JzuPvyTozQSts7QixnyY1N8CD+-ZuteHodCpmRA@mail.gmail.com/
Alexei Starovoitov Oct. 19, 2021, 10:31 p.m. UTC | #2
On Tue, Oct 19, 2021 at 2:35 AM Quentin Monnet <quentin@isovalent.com> wrote:
>
> 2021-10-19 09:04 UTC+0100 ~ Mauro Carvalho Chehab
> <mchehab+huawei@kernel.org>
> > The file name: Documentation/bpftool-cgroup.rst
> > should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.
> >
> > Update its cross-reference accordingly.
> >
> > Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
> > Fixes: 5ccda64d38cc ("bpftool: implement cgroup bpf operations")
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >
> > To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> > See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/
> >
> >  tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > index be54b7335a76..617b8084c440 100755
> > --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > @@ -392,7 +392,7 @@ class ManCgroupExtractor(ManPageExtractor):
> >      """
> >      An extractor for bpftool-cgroup.rst.
> >      """
> > -    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-cgroup.rst')
> > +    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-cgroup.rst')
> >
> >      def get_attach_types(self):
> >          return self.get_rst_list('ATTACH_TYPE')
> >
>
> No, this change is incorrect. We have discussed it several times before
> [0][1]. Please drop this patch.

+1
Mauro Carvalho Chehab Oct. 20, 2021, 5:46 a.m. UTC | #3
Em Tue, 19 Oct 2021 15:31:38 -0700
Alexei Starovoitov <alexei.starovoitov@gmail.com> escreveu:

> On Tue, Oct 19, 2021 at 2:35 AM Quentin Monnet <quentin@isovalent.com> wrote:
> >
> > 2021-10-19 09:04 UTC+0100 ~ Mauro Carvalho Chehab
> > <mchehab+huawei@kernel.org>  
> > > The file name: Documentation/bpftool-cgroup.rst
> > > should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.
> > >
> > > Update its cross-reference accordingly.
> > >
> > > Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
> > > Fixes: 5ccda64d38cc ("bpftool: implement cgroup bpf operations")
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > > ---
> > >
> > > To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> > > See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/
> > >
> > >  tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > >
> > > diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > > index be54b7335a76..617b8084c440 100755
> > > --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > > +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > > @@ -392,7 +392,7 @@ class ManCgroupExtractor(ManPageExtractor):
> > >      """
> > >      An extractor for bpftool-cgroup.rst.
> > >      """
> > > -    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-cgroup.rst')
> > > +    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-cgroup.rst')
> > >
> > >      def get_attach_types(self):
> > >          return self.get_rst_list('ATTACH_TYPE')
> > >  
> >
> > No, this change is incorrect. We have discussed it several times before
> > [0][1]. Please drop this patch.  
> 
> +1

Sorry, left-over. I dropped two other patches, but forgot to also drop
this one.

Regards,
Mauro
diff mbox series

Patch

diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
index be54b7335a76..617b8084c440 100755
--- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
+++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
@@ -392,7 +392,7 @@  class ManCgroupExtractor(ManPageExtractor):
     """
     An extractor for bpftool-cgroup.rst.
     """
-    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-cgroup.rst')
+    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-cgroup.rst')
 
     def get_attach_types(self):
         return self.get_rst_list('ATTACH_TYPE')