Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference
To:     Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc:     Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        Jonathan Corbet <corbet@lwn.net>,
        "David S. Miller" <davem@davemloft.net>,
        Alexei Starovoitov <ast@kernel.org>,
        Andrii Nakryiko <andrii@kernel.org>,
        Daniel Borkmann <daniel@iogearbox.net>,
        David Beckett <david.beckett@netronome.com>,
        Jakub Kicinski <kuba@kernel.org>,
        John Fastabend <john.fastabend@gmail.com>,
        KP Singh <kpsingh@kernel.org>, Martin KaFai Lau <kafai@fb.com>,
        Shuah Khan <shuah@kernel.org>,
        Song Liu <songliubraving@fb.com>, Yonghong Song <yhs@fb.com>,
        bpf@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-kselftest@vger.kernel.org, netdev@vger.kernel.org
References: <cover.1631783482.git.mchehab+huawei@kernel.org>
 <dc4bae7a14518fbfff20a0f539df06a5c19b09de.1631783482.git.mchehab+huawei@kernel.org>
 <eb80e8f5-b9d7-5031-8ebb-4595bb295dbf@isovalent.com>
 <20210916124930.7ae3b722@coco.lan>
From:   Quentin Monnet <quentin@isovalent.com>
Message-ID: <33d66a49-2fc0-57a1-c1e5-34e932bcc237@isovalent.com>
Date:   Thu, 16 Sep 2021 11:57:51 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.14.0
MIME-Version: 1.0
In-Reply-To: <20210916124930.7ae3b722@coco.lan>
Content-Type: text/plain; charset=utf-8
Content-Language: en-GB
Content-Transfer-Encoding: 7bit
Precedence: bulk

2021-09-16 12:49 UTC+0200 ~ Mauro Carvalho Chehab
<mchehab+huawei@kernel.org>
> Hi Quentin,
> 
> Em Thu, 16 Sep 2021 10:43:45 +0100
> Quentin Monnet <quentin@isovalent.com> escreveu:
> 
>> 2021-09-16 11:14 UTC+0200 ~ Mauro Carvalho Chehab
>> <mchehab+huawei@kernel.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@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..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