docs/bpf: Fix invalid link of "Documentation/bpf/btf.rst"

[PATCH] docs/bpf: Fix invalid link of "Documentation/bpf/btf.rst"

Posted by Tiezhu Yang 2 years, 6 months ago

"Documentation/bpf/btf.rst" is linked to the following invalid web page:

https://www.kernel.org/doc/html/latest/bpf/btf.rst

The correct link should be:

https://www.kernel.org/doc/html/latest/bpf/btf.html

Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn>
---
 Documentation/bpf/bpf_devel_QA.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index 03d4993..f54c328 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -690,6 +690,7 @@ when:
    https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
 .. _Documentation/dev-tools/kselftest.rst:
    https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
-.. _Documentation/bpf/btf.rst: btf.rst
+.. _Documentation/bpf/btf.rst:
+   https://www.kernel.org/doc/html/latest/bpf/btf.html
 
 Happy BPF hacking!
-- 
2.1.0

Re: [PATCH] docs/bpf: Fix invalid link of "Documentation/bpf/btf.rst"

Posted by Bagas Sanjaya 2 years, 6 months ago

On Wed, Feb 22, 2023 at 11:10:01AM +0800, Tiezhu Yang wrote:
> "Documentation/bpf/btf.rst" is linked to the following invalid web page:
> 
> https://www.kernel.org/doc/html/latest/bpf/btf.rst
> 
> The correct link should be:
> 
> https://www.kernel.org/doc/html/latest/bpf/btf.html
> 
> Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn>

Hi,

I have already submitted a different fix to the same problem at [1] (v2
at [2]). Please take a look at there.

[1]: https://lore.kernel.org/linux-doc/20230219030956.22662-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/20230222083530.26136-1-bagasdotme@gmail.com/

> diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
> index 03d4993..f54c328 100644
> --- a/Documentation/bpf/bpf_devel_QA.rst
> +++ b/Documentation/bpf/bpf_devel_QA.rst
> @@ -690,6 +690,7 @@ when:
>     https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
>  .. _Documentation/dev-tools/kselftest.rst:
>     https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
> -.. _Documentation/bpf/btf.rst: btf.rst
> +.. _Documentation/bpf/btf.rst:
> +   https://www.kernel.org/doc/html/latest/bpf/btf.html
>  
>  Happy BPF hacking!

For consistency with my fix above, can you please convert these in-tree links
from using external link to simply write the doc path instead? 

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] docs/bpf: Fix invalid link of "Documentation/bpf/btf.rst"

Posted by Tiezhu Yang 2 years, 6 months ago


On 02/22/2023 04:54 PM, Bagas Sanjaya wrote:
> On Wed, Feb 22, 2023 at 11:10:01AM +0800, Tiezhu Yang wrote:
>> "Documentation/bpf/btf.rst" is linked to the following invalid web page:
>>
>> https://www.kernel.org/doc/html/latest/bpf/btf.rst
>>
>> The correct link should be:
>>
>> https://www.kernel.org/doc/html/latest/bpf/btf.html
>>
>> Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn>
>
> Hi,
>
> I have already submitted a different fix to the same problem at [1] (v2
> at [2]). Please take a look at there.

Oh, I am sorry, I did not notice these patches, I found this issue when
I read the bpf doc.

>
> [1]: https://lore.kernel.org/linux-doc/20230219030956.22662-1-bagasdotme@gmail.com/
> [2]: https://lore.kernel.org/linux-doc/20230222083530.26136-1-bagasdotme@gmail.com/
>
>> diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
>> index 03d4993..f54c328 100644
>> --- a/Documentation/bpf/bpf_devel_QA.rst
>> +++ b/Documentation/bpf/bpf_devel_QA.rst
>> @@ -690,6 +690,7 @@ when:
>>     https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
>>  .. _Documentation/dev-tools/kselftest.rst:
>>     https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
>> -.. _Documentation/bpf/btf.rst: btf.rst
>> +.. _Documentation/bpf/btf.rst:
>> +   https://www.kernel.org/doc/html/latest/bpf/btf.html
>>
>>  Happy BPF hacking!
>
> For consistency with my fix above, can you please convert these in-tree links
> from using external link to simply write the doc path instead?
>
> Thanks.
>

Please ignore my patch, you can go on to modify your changes.
Please let me know if there is anything I need to do.

Thanks,
Tiezhu