From patchwork Fri Jan 17 14:19:51 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Numan Siddique X-Patchwork-Id: 1224848 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=140.211.166.137; helo=fraxinus.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=ovn.org Received: from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 47zjrz2Xkzz9sRR for ; Sat, 18 Jan 2020 01:20:32 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id CFDFE86226; Fri, 17 Jan 2020 14:20:30 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id HKvXrK_rIjx1; Fri, 17 Jan 2020 14:20:27 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by fraxinus.osuosl.org (Postfix) with ESMTP id EC25086521; Fri, 17 Jan 2020 14:20:26 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 9DD51C18DC; Fri, 17 Jan 2020 14:20:26 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from silver.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by lists.linuxfoundation.org (Postfix) with ESMTP id CEBFFC077D for ; Fri, 17 Jan 2020 14:20:25 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id BC263203BB for ; Fri, 17 Jan 2020 14:20:25 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dstJG9DDeild for ; Fri, 17 Jan 2020 14:20:20 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by silver.osuosl.org (Postfix) with ESMTPS id 8193420422 for ; Fri, 17 Jan 2020 14:20:20 +0000 (UTC) X-Originating-IP: 115.99.45.99 Received: from nummac.local (unknown [115.99.45.99]) (Authenticated sender: numans@ovn.org) by relay6-d.mail.gandi.net (Postfix) with ESMTPSA id 006EBC0013; Fri, 17 Jan 2020 14:20:16 +0000 (UTC) From: numans@ovn.org To: dev@openvswitch.org Date: Fri, 17 Jan 2020 19:49:51 +0530 Message-Id: <20200117141951.2185832-1-numans@ovn.org> X-Mailer: git-send-email 2.24.1 MIME-Version: 1.0 Cc: Lars Kellogg-Stedman Subject: [ovs-dev] [PATCH] Fix links to ovs-advanced tutorial X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" From: Lars Kellogg-Stedman 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 --- 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 `__ For answers to common questions, refer to the `FAQ `__. To learn about some advanced features of the Open vSwitch software switch, read -the `tutorial `__. +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