2020-07-29 13:16:49

by Tiezhu Yang

Subject: [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst

There exists an error "404 Not Found" when I click the html link of
"Documentation/networking/filter.rst" in the BPF documentation [1],
fix it.

Additionally, use the new links about "BPF and XDP Reference Guide"
and "bpf(2)" to avoid redirects.

[1] https://www.kernel.org/doc/html/latest/bpf/

Fixes: d9b9170a2653 ("docs: bpf: Rename README.rst to index.rst")
Fixes: cb3f0d56e153 ("docs: networking: convert filter.txt to ReST")
Signed-off-by: Tiezhu Yang <[email protected]>
---

v2:
- Fix a typo "clik" to "click" in the commit message, sorry for that

Documentation/bpf/index.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
index 26f4bb3..1b901b4 100644
--- a/Documentation/bpf/index.rst
+++ b/Documentation/bpf/index.rst
@@ -68,7 +68,7 @@ Testing and debugging BPF


.. Links:
-.. _Documentation/networking/filter.rst: ../networking/filter.txt
+.. _Documentation/networking/filter.rst: ../networking/filter.html
.. _man-pages: https://www.kernel.org/doc/man-pages/
-.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
-.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/
+.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html
+.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/
--
2.1.0

2020-07-29 21:06:51

by Song Liu

Subject: Re: [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst

On Wed, Jul 29, 2020 at 6:17 AM Tiezhu Yang <[email protected]> wrote:
>
> There exists an error "404 Not Found" when I click the html link of
> "Documentation/networking/filter.rst" in the BPF documentation [1],
> fix it.
>
> Additionally, use the new links about "BPF and XDP Reference Guide"
> and "bpf(2)" to avoid redirects.
>
> [1] https://www.kernel.org/doc/html/latest/bpf/
>
> Fixes: d9b9170a2653 ("docs: bpf: Rename README.rst to index.rst")
> Fixes: cb3f0d56e153 ("docs: networking: convert filter.txt to ReST")
> Signed-off-by: Tiezhu Yang <[email protected]>
> ---
>
> v2:
> - Fix a typo "clik" to "click" in the commit message, sorry for that
>
> Documentation/bpf/index.rst | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
> index 26f4bb3..1b901b4 100644
> --- a/Documentation/bpf/index.rst
> +++ b/Documentation/bpf/index.rst
> @@ -68,7 +68,7 @@ Testing and debugging BPF
>
>
> .. Links:
> -.. _Documentation/networking/filter.rst: ../networking/filter.txt
> +.. _Documentation/networking/filter.rst: ../networking/filter.html

This should be filter.rst, no?

> .. _man-pages: https://www.kernel.org/doc/man-pages/
> -.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
> -.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/
> +.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html
> +.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/
> --
> 2.1.0
>

2020-07-29 23:55:13

by Tiezhu Yang

Subject: Re: [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst

On 07/30/2020 05:06 AM, Song Liu wrote:
> On Wed, Jul 29, 2020 at 6:17 AM Tiezhu Yang <[email protected]> wrote:
>> There exists an error "404 Not Found" when I click the html link of
>> "Documentation/networking/filter.rst" in the BPF documentation [1],
>> fix it.
>>
>> Additionally, use the new links about "BPF and XDP Reference Guide"
>> and "bpf(2)" to avoid redirects.
>>
>> [1] https://www.kernel.org/doc/html/latest/bpf/
>>
>> Fixes: d9b9170a2653 ("docs: bpf: Rename README.rst to index.rst")
>> Fixes: cb3f0d56e153 ("docs: networking: convert filter.txt to ReST")
>> Signed-off-by: Tiezhu Yang <[email protected]>
>> ---
>>
>> v2:
>> - Fix a typo "clik" to "click" in the commit message, sorry for that
>>
>> Documentation/bpf/index.rst | 6 +++---
>> 1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
>> index 26f4bb3..1b901b4 100644
>> --- a/Documentation/bpf/index.rst
>> +++ b/Documentation/bpf/index.rst
>> @@ -68,7 +68,7 @@ Testing and debugging BPF
>>
>>
>> .. Links:
>> -.. _Documentation/networking/filter.rst: ../networking/filter.txt
>> +.. _Documentation/networking/filter.rst: ../networking/filter.html
> This should be filter.rst, no?

Hi Song,

Thanks for your reply.

I use filter.rst first, but it still appears "404 not found" when I click
this link after "make htmldocs", so I use filter.html finally.

Am I missing something? Is the test method OK?
Please correct me if I am wrong.

Thanks,
Tiezhu

>
>> .. _man-pages: https://www.kernel.org/doc/man-pages/
>> -.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
>> -.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/
>> +.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html
>> +.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/
>> --
>> 2.1.0
>>