| Message ID | 803e3a74d7f9b5fe23e4f8222af0e6629d1cd76a.1631785820.git.mchehab+huawei@kernel.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Fix some issues at documentation | expand |
On Thu, Sep 16, 2021 at 2:55 AM Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > The file name: Documentation/bpftool-map.rst > should be, instead: tools/bpf/bpftool/Documentation/bpftool-map.rst. > > Update its cross-reference accordingly. > > Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion") > Fixes: ff69c21a85a4 ("tools: bpftool: add documentation") > Signed-off-by: Mauro Carvalho Chehab <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 27a2c369a798..2d7eb683bd5a 100755 > --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py > +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py > @@ -383,7 +383,7 @@ class ManMapExtractor(ManPageExtractor): > """ > An extractor for bpftool-map.rst. > """ > - filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-map.rst') > + filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-map.rst') this is wrong, BPFTOOL_DIR already includes "tools/bpf/bpftool" part. Did you test this? There are many places where BPFTOOL_DIR is joined with bpftool-local file paths, you haven't updated them. So I assume this was done blindly with some sort of script? Please be careful with such changes. > > def get_map_types(self): > return self.get_rst_list('TYPE') > -- > 2.31.1 >
diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py index 27a2c369a798..2d7eb683bd5a 100755 --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py @@ -383,7 +383,7 @@ class ManMapExtractor(ManPageExtractor): """ An extractor for bpftool-map.rst. """ - filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-map.rst') + filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-map.rst') def get_map_types(self): return self.get_rst_list('TYPE')
The file name: Documentation/bpftool-map.rst should be, instead: tools/bpf/bpftool/Documentation/bpftool-map.rst. Update its cross-reference accordingly. Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion") Fixes: ff69c21a85a4 ("tools: bpftool: add documentation") Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)