Skip to content

Commit

Permalink
Fix links to ovs-advanced tutorial
Browse files Browse the repository at this point in the history
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 ovn-org#7
  • Loading branch information
larsks committed Jan 11, 2020
1 parent bcf6d23 commit 4e86831
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion Documentation/tutorials/ovn-sandbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,15 @@ 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
--gdb-ovn-controller
--gdb-ovn-controller-vtep

.. _ovs_advanced: https://github.com/openvswitch/ovs/blob/master/Documentation/tutorials/ovs-advanced.rst

Creating OVN Resources
----------------------

Expand Down
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4e86831

Please sign in to comment.