diff mbox series

[ovs-dev] Fix links to ovs-advanced tutorial

Message ID 20200117141951.2185832-1-numans@ovn.org
State Accepted
Headers show
Series [ovs-dev] Fix links to ovs-advanced tutorial | expand

Commit Message

Numan Siddique Jan. 17, 2020, 2:19 p.m. UTC
From: Lars Kellogg-Stedman <lars@redhat.com>

This fixes the broken link in the README to the ovs-advanced tutorial.
This also adds a hyperlink to Documentation/tutorials/ovn-sandbox.rst
where the tutorial is referenced.

Closes #7

Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
---
 Documentation/tutorials/ovn-sandbox.rst | 4 +++-
 README.rst                              | 4 +++-
 2 files changed, 6 insertions(+), 2 deletions(-)

Comments

Numan Siddique Jan. 17, 2020, 2:40 p.m. UTC | #1
On Fri, Jan 17, 2020 at 7:50 PM <numans@ovn.org> wrote:
>
> From: Lars Kellogg-Stedman <lars@redhat.com>
>
> This fixes the broken link in the README to the ovs-advanced tutorial.
> This also adds a hyperlink to Documentation/tutorials/ovn-sandbox.rst
> where the tutorial is referenced.
>
> Closes #7

Thanks for the PR Lars.

I applied this patch to master.

Numan

>
> Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
> ---
>  Documentation/tutorials/ovn-sandbox.rst | 4 +++-
>  README.rst                              | 4 +++-
>  2 files changed, 6 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/tutorials/ovn-sandbox.rst b/Documentation/tutorials/ovn-sandbox.rst
> index a150109d8..2b574c02f 100644
> --- a/Documentation/tutorials/ovn-sandbox.rst
> +++ b/Documentation/tutorials/ovn-sandbox.rst
> @@ -62,7 +62,7 @@ Using GDB
>  ---------
>
>  GDB support is not required to go through the tutorial. See the "Using GDB"
> -section of ovs-advanced in Open vSwitch documentation for more info.
> +section of `ovs-advanced`_ in Open vSwitch documentation for more info.
>  Additional flags exist for launching the debugger for the OVN programs::
>
>      --gdb-ovn-northd
> @@ -173,3 +173,5 @@ man page for more detail.
>  .. _ovn-nbctl(8): http://openvswitch.org/support/dist-docs/ovn-nbctl.8.html
>  .. _ovn-sbctl(8): http://openvswitch.org/support/dist-docs/ovn-sbctl.8.html
>  .. _ovn-trace(8): http://openvswitch.org/support/dist-docs/ovn-trace.8.html
> +.. _ovs-advanced: https://github.com/openvswitch/ovs/blob/master/Documentation/tutorials/ovs-advanced.rst
> +
> diff --git a/README.rst b/README.rst
> index 57cf3a8a6..01d782331 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -62,7 +62,9 @@ installation guides <Documentation/intro/install/index.rst>`__
>  For answers to common questions, refer to the `FAQ <Documentation/faq>`__.
>
>  To learn about some advanced features of the Open vSwitch software switch, read
> -the `tutorial <Documentation/tutorials/ovs-advanced.rst>`__.
> +the tutorial_.
> +
> +.. _tutorial: https://github.com/openvswitch/ovs/blob/master/Documentation/tutorials/ovs-advanced.rst
>
>  Each OVN program is accompanied by a manpage.  Many of the manpages are customized
>  to your configuration as part of the build process, so we recommend building OVN
> --
> 2.24.1
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
0-day Robot Jan. 17, 2020, 2:57 p.m. UTC | #2
Bleep bloop.  Greetings Numan Siddique, 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.


git-am:
fatal: sha1 information is lacking or useless (Documentation/tutorials/ovn-sandbox.rst).
Repository lacks necessary blobs to fall back on 3-way merge.
Cannot fall back to three-way merge.
Patch failed at 0001 Fix links to ovs-advanced tutorial
The copy of the patch that failed is found in:
   /var/lib/jenkins/jobs/upstream_build_from_pw/workspace/.git/rebase-apply/patch
When you have resolved this problem, run "git am --resolved".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".


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

Thanks,
0-day Robot
diff mbox series

Patch

diff --git a/Documentation/tutorials/ovn-sandbox.rst b/Documentation/tutorials/ovn-sandbox.rst
index a150109d8..2b574c02f 100644
--- a/Documentation/tutorials/ovn-sandbox.rst
+++ b/Documentation/tutorials/ovn-sandbox.rst
@@ -62,7 +62,7 @@  Using GDB
 ---------
 
 GDB support is not required to go through the tutorial. See the "Using GDB"
-section of ovs-advanced in Open vSwitch documentation for more info.
+section of `ovs-advanced`_ in Open vSwitch documentation for more info.
 Additional flags exist for launching the debugger for the OVN programs::
 
     --gdb-ovn-northd
@@ -173,3 +173,5 @@  man page for more detail.
 .. _ovn-nbctl(8): http://openvswitch.org/support/dist-docs/ovn-nbctl.8.html
 .. _ovn-sbctl(8): http://openvswitch.org/support/dist-docs/ovn-sbctl.8.html
 .. _ovn-trace(8): http://openvswitch.org/support/dist-docs/ovn-trace.8.html
+.. _ovs-advanced: https://github.com/openvswitch/ovs/blob/master/Documentation/tutorials/ovs-advanced.rst
+
diff --git a/README.rst b/README.rst
index 57cf3a8a6..01d782331 100644
--- a/README.rst
+++ b/README.rst
@@ -62,7 +62,9 @@  installation guides <Documentation/intro/install/index.rst>`__
 For answers to common questions, refer to the `FAQ <Documentation/faq>`__.
 
 To learn about some advanced features of the Open vSwitch software switch, read
-the `tutorial <Documentation/tutorials/ovs-advanced.rst>`__.
+the tutorial_.
+
+.. _tutorial: https://github.com/openvswitch/ovs/blob/master/Documentation/tutorials/ovs-advanced.rst
 
 Each OVN program is accompanied by a manpage.  Many of the manpages are customized
 to your configuration as part of the build process, so we recommend building OVN