diff mbox series

[ovs-dev] Fix documentation broken links

Message ID 20220428233457.14738-1-aserdean@ovn.org
State Changes Requested
Headers show
Series [ovs-dev] Fix documentation broken links | expand

Checks

Context Check Description
ovsrobot/apply-robot warning apply and check: warning
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/intel-ovs-compilation success test: success

Commit Message

Alin-Gabriel Serdean April 28, 2022, 11:34 p.m. UTC
Signed-off-by: Alin-Gabriel Serdean <aserdean@ovn.org>
---
 Documentation/howto/qos.rst                               | 8 ++++----
 .../internals/contributing/documentation-style.rst        | 2 +-
 Documentation/topics/testing.rst                          | 2 +-
 Documentation/topics/windows.rst                          | 2 +-
 4 files changed, 7 insertions(+), 7 deletions(-)

Comments

0-day Robot April 28, 2022, 11:59 p.m. UTC | #1
Bleep bloop.  Greetings Alin-Gabriel Serdean, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
WARNING: Line is 80 characters long (recommended limit is 79)
#26 FILE: Documentation/howto/qos.rst:62:
<https://hewlettpackard.github.io/netperf/>`__, a free tool for testing the rate

WARNING: Line is 92 characters long (recommended limit is 79)
#68 FILE: Documentation/topics/windows.rst:504:
.. [3] DPIF Provider https://github.com/openvswitch/ovs/blob/branch-2.17/lib/dpif-provider.h

Lines checked: 75, Warnings: 2, Errors: 0


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
Paolo Valerio May 5, 2022, 6:21 p.m. UTC | #2
Hello Alin,

Alin-Gabriel Serdean <aserdean@ovn.org> writes:

> Signed-off-by: Alin-Gabriel Serdean <aserdean@ovn.org>
> ---
>  Documentation/howto/qos.rst                               | 8 ++++----
>  .../internals/contributing/documentation-style.rst        | 2 +-
>  Documentation/topics/testing.rst                          | 2 +-
>  Documentation/topics/windows.rst                          | 2 +-
>  4 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/howto/qos.rst b/Documentation/howto/qos.rst
> index 4462856ba..2707d1d60 100644
> --- a/Documentation/howto/qos.rst
> +++ b/Documentation/howto/qos.rst
> @@ -59,10 +59,10 @@ is participating in an OVS bridge, no IP address can be assigned on `eth0`.
>  
>  The second host, named Measurement Host, can be any host capable of measuring
>  throughput from a VM. For this guide, we use `netperf
> -<http://www.netperf.org>`__, a free tool for testing the rate at which one host
> -can send to another. The Measurement Host has only a single NIC, `eth0`, which
> -is connected to the Data Network. `eth0` has an IP address that can reach any
> -VM on `host1`.
> +<https://hewlettpackard.github.io/netperf/>`__, a free tool for testing the rate
> +at which one host can send to another. The Measurement Host has only a single
> +NIC, `eth0`, which is connected to the Data Network. `eth0` has an IP address
> +that can reach any VM on `host1`.
>  
>  Two VMs
>  ~~~~~~~
> diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst
> index 045cdf696..04a9829f1 100644
> --- a/Documentation/internals/contributing/documentation-style.rst
> +++ b/Documentation/internals/contributing/documentation-style.rst
> @@ -423,7 +423,7 @@ Helpful Tools
>  There are a number of tools, online and offline, which can be used to preview
>  documents are you edit them:
>  
> -- `rst.ninjs.org <http://rst.ninjs.org/>`__
> +- `rst.ninjs.org <https://github.com/anru/rsted>`__
>  
>    An online rST editor/previewer
>  
> diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst
> index c15d5b38f..f551b61e1 100644
> --- a/Documentation/topics/testing.rst
> +++ b/Documentation/topics/testing.rst
> @@ -447,7 +447,7 @@ datapath testsuite.
>    an updated iproute2 utilities package.  The package is available from
>    the Linux kernel organization open source git repositories.
>  
> -  https://git.kernel.org/pub/scm/linux/kernel/git/shemminger/iproute2.git
> +  https://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/iproute2.git
>

what about using:

https://git.kernel.org/pub/scm/network/iproute2/iproute2.git

it should be the most reliable.

>  .. _testing-static-analysis:
>  
> diff --git a/Documentation/topics/windows.rst b/Documentation/topics/windows.rst
> index c5b34c85f..cb220b156 100644
> --- a/Documentation/topics/windows.rst
> +++ b/Documentation/topics/windows.rst
> @@ -501,7 +501,7 @@ References
>  
>  .. [1] Hyper-V Extensible Switch https://msdn.microsoft.com/windows/hardware/drivers/network/hyper-v-extensible-switch
>  .. [2] Hyper-V Extensible Switch Extensions https://msdn.microsoft.com/windows/hardware/drivers/network/hyper-v-extensible-switch-extensions
> -.. [3] DPIF Provider http://openvswitch.sourcearchive.com/documentation/1.1.0-1/dpif-provider_8h_source.html
> +.. [3] DPIF Provider https://github.com/openvswitch/ovs/blob/branch-2.17/lib/dpif-provider.h

any particular reason you picked branch-2.17 instead of

https://github.com/openvswitch/ovs/blob/master/lib/dpif-provider.h

>  .. [4] Hyper-V Extensible Switch Components https://msdn.microsoft.com/windows/hardware/drivers/network/hyper-v-extensible-switch-components
>  .. [5] Windows Filtering Platform https://msdn.microsoft.com/en-us/library/windows/desktop/aa366510(v=vs.85).aspx
>  .. [6] IP Helper https://msdn.microsoft.com/windows/hardware/drivers/network/ip-helper
> -- 
> 2.32.0
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
diff mbox series

Patch

diff --git a/Documentation/howto/qos.rst b/Documentation/howto/qos.rst
index 4462856ba..2707d1d60 100644
--- a/Documentation/howto/qos.rst
+++ b/Documentation/howto/qos.rst
@@ -59,10 +59,10 @@  is participating in an OVS bridge, no IP address can be assigned on `eth0`.
 
 The second host, named Measurement Host, can be any host capable of measuring
 throughput from a VM. For this guide, we use `netperf
-<http://www.netperf.org>`__, a free tool for testing the rate at which one host
-can send to another. The Measurement Host has only a single NIC, `eth0`, which
-is connected to the Data Network. `eth0` has an IP address that can reach any
-VM on `host1`.
+<https://hewlettpackard.github.io/netperf/>`__, a free tool for testing the rate
+at which one host can send to another. The Measurement Host has only a single
+NIC, `eth0`, which is connected to the Data Network. `eth0` has an IP address
+that can reach any VM on `host1`.
 
 Two VMs
 ~~~~~~~
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst
index 045cdf696..04a9829f1 100644
--- a/Documentation/internals/contributing/documentation-style.rst
+++ b/Documentation/internals/contributing/documentation-style.rst
@@ -423,7 +423,7 @@  Helpful Tools
 There are a number of tools, online and offline, which can be used to preview
 documents are you edit them:
 
-- `rst.ninjs.org <http://rst.ninjs.org/>`__
+- `rst.ninjs.org <https://github.com/anru/rsted>`__
 
   An online rST editor/previewer
 
diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst
index c15d5b38f..f551b61e1 100644
--- a/Documentation/topics/testing.rst
+++ b/Documentation/topics/testing.rst
@@ -447,7 +447,7 @@  datapath testsuite.
   an updated iproute2 utilities package.  The package is available from
   the Linux kernel organization open source git repositories.
 
-  https://git.kernel.org/pub/scm/linux/kernel/git/shemminger/iproute2.git
+  https://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/iproute2.git
 
 .. _testing-static-analysis:
 
diff --git a/Documentation/topics/windows.rst b/Documentation/topics/windows.rst
index c5b34c85f..cb220b156 100644
--- a/Documentation/topics/windows.rst
+++ b/Documentation/topics/windows.rst
@@ -501,7 +501,7 @@  References
 
 .. [1] Hyper-V Extensible Switch https://msdn.microsoft.com/windows/hardware/drivers/network/hyper-v-extensible-switch
 .. [2] Hyper-V Extensible Switch Extensions https://msdn.microsoft.com/windows/hardware/drivers/network/hyper-v-extensible-switch-extensions
-.. [3] DPIF Provider http://openvswitch.sourcearchive.com/documentation/1.1.0-1/dpif-provider_8h_source.html
+.. [3] DPIF Provider https://github.com/openvswitch/ovs/blob/branch-2.17/lib/dpif-provider.h
 .. [4] Hyper-V Extensible Switch Components https://msdn.microsoft.com/windows/hardware/drivers/network/hyper-v-extensible-switch-components
 .. [5] Windows Filtering Platform https://msdn.microsoft.com/en-us/library/windows/desktop/aa366510(v=vs.85).aspx
 .. [6] IP Helper https://msdn.microsoft.com/windows/hardware/drivers/network/ip-helper