Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst
@ 2020-07-29 13:15 Tiezhu Yang
  2020-07-29 21:06 ` Song Liu
  0 siblings, 1 reply; 3+ messages in thread
From: Tiezhu Yang @ 2020-07-29 13:15 UTC (permalink / raw)
  To: Jonathan Corbet, Alexei Starovoitov, Daniel Borkmann,
	Martin KaFai Lau, Song Liu, Yonghong Song, Andrii Nakryiko,
	John Fastabend, KP Singh
  Cc: Tobin C. Harding, Mauro Carvalho Chehab, linux-doc, netdev, bpf,
	linux-kernel

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 <yangtiezhu@loongson.cn>
---

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst
  2020-07-29 13:15 [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst Tiezhu Yang
@ 2020-07-29 21:06 ` Song Liu
  2020-07-29 23:54   ` Tiezhu Yang
  0 siblings, 1 reply; 3+ messages in thread
From: Song Liu @ 2020-07-29 21:06 UTC (permalink / raw)
  To: Tiezhu Yang
  Cc: Jonathan Corbet, Alexei Starovoitov, Daniel Borkmann,
	Martin KaFai Lau, Song Liu, Yonghong Song, Andrii Nakryiko,
	John Fastabend, KP Singh, Tobin C. Harding,
	Mauro Carvalho Chehab, Linux Doc Mailing List, Networking, bpf,
	open list

On Wed, Jul 29, 2020 at 6:17 AM Tiezhu Yang <yangtiezhu@loongson.cn> 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 <yangtiezhu@loongson.cn>
> ---
>
> 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
>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst
  2020-07-29 21:06 ` Song Liu
@ 2020-07-29 23:54   ` Tiezhu Yang
  0 siblings, 0 replies; 3+ messages in thread
From: Tiezhu Yang @ 2020-07-29 23:54 UTC (permalink / raw)
  To: Song Liu
  Cc: Jonathan Corbet, Alexei Starovoitov, Daniel Borkmann,
	Martin KaFai Lau, Song Liu, Yonghong Song, Andrii Nakryiko,
	John Fastabend, KP Singh, Tobin C. Harding,
	Mauro Carvalho Chehab, Linux Doc Mailing List, Networking, bpf,
	open list

On 07/30/2020 05:06 AM, Song Liu wrote:
> On Wed, Jul 29, 2020 at 6:17 AM Tiezhu Yang <yangtiezhu@loongson.cn> 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 <yangtiezhu@loongson.cn>
>> ---
>>
>> 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
>>


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, back to index

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-29 13:15 [PATCH bpf-next v2] Documentation/bpf: Use valid and new links in index.rst Tiezhu Yang
2020-07-29 21:06 ` Song Liu
2020-07-29 23:54   ` Tiezhu Yang

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git