linux-kernel - Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <33d66a49-2fc0-57a1-c1e5-34e932bcc237@isovalent.com>
Date:   Thu, 16 Sep 2021 11:57:51 +0100
From:   Quentin Monnet <quentin@...valent.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>,
        Alexei Starovoitov <ast@...nel.org>,
        Andrii Nakryiko <andrii@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        David Beckett <david.beckett@...ronome.com>,
        Jakub Kicinski <kuba@...nel.org>,
        John Fastabend <john.fastabend@...il.com>,
        KP Singh <kpsingh@...nel.org>, Martin KaFai Lau <kafai@...com>,
        Shuah Khan <shuah@...nel.org>,
        Song Liu <songliubraving@...com>, Yonghong Song <yhs@...com>,
        bpf@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-kselftest@...r.kernel.org, netdev@...r.kernel.org
Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

2021-09-16 12:49 UTC+0200 ~ Mauro Carvalho Chehab
<mchehab+huawei@...nel.org>
> Hi Quentin,
> 
> Em Thu, 16 Sep 2021 10:43:45 +0100
> Quentin Monnet <quentin@...valent.com> escreveu:
> 
>> 2021-09-16 11:14 UTC+0200 ~ Mauro Carvalho Chehab
>> <mchehab+huawei@...nel.org>
>>> The file name: Documentation/bpftool-prog.rst
>>> should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst.
>>>
>>> Update its cross-reference accordingly.
>>>
>>> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
>>> Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")  
>>
>> Hi,
>> How is this a fix for the commit that added the documentation in bpftool?
>>
>>> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.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..27a2c369a798 100755
>>> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
>>> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
>>> @@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor):
>>>      """
>>>      An extractor for bpftool-prog.rst.
>>>      """
>>> -    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst')
>>> +    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst')
>>>  
>>>      def get_attach_types(self):
>>>          return self.get_rst_list('ATTACH_TYPE')
>>>   
>>
>> No I don't believe it should. BPFTOOL_DIR already contains
>> 'tools/bpf/bpftool' and the os.path.join() concatenates the two path
>> fragments.
>>
>> Where is this suggestion coming from? Did you face an issue with the script?
> 
> No, I didn't face any issues with this script.
> 
> The suggestion cames from the script at:
> 
> 	./scripts/documentation-file-ref-check
> 
> which is meant to discover broken doc references. 
> 
> Such script has already a rule to handle stuff under tools/:
> 
> 		# Accept relative Documentation patches for tools/
> 		if ($f =~ m/tools/) {
> 			my $path = $f;
> 			$path =~ s,(.*)/.*,$1,;
> 			next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref"));
> 		}
> 
> but it seems it needs a fixup in order for it to stop reporting issues
> at test_bpftool_synctypes.py:
> 
> 	$ ./scripts/documentation-file-ref-check 
> 	...
> 	tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-prog.rst
> 	tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-map.rst
> 	tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-cgroup.rst

Oh, I see, thanks for explaining. I didn't know this script would catch
the paths in bpftool's test file.

> 
> I'll drop the patches touching it for a next version, probably
> adding a fix for such script.
> 
> Thanks,
> Mauro
> 

Sounds good to me, thanks a lot!
Quentin