[ovs-dev] [PATCH] README: Make it clear that ovs-openflowd is an alternative to ovs-vswitchd.

[Justin Pettit]

Looks good.

--Justin


On Oct 14, 2010, at 9:44 AM, Ben Pfaff wrote:

> On Thu, Oct 14, 2010 at 09:30:41AM -0700, Justin Pettit wrote:
>> Looks good.  Vishal pointed out that the man page for ovs-openflowd
>> also doesn't mention that it shouldn't be run with ovs-vswitchd.  It
>> may be nice to add something there, too.
> 
> Sure.  Here's a new version.
> 
> --8<--------------------------cut here-------------------------->8--
> 
> From: Ben Pfaff <blp at nicira.com>
> Date: Thu, 14 Oct 2010 09:44:26 -0700
> Subject: [PATCH] docs: Make it clear that ovs-openflowd is an alternative to ovs-vswitchd.
> 
> Suggested-by: Vishal Swarankar <vishal.swarnkar at gmail.com>
> ---
> AUTHORS                      |    1 +
> README                       |    6 +++---
> utilities/ovs-openflowd.8.in |    3 +++
> vswitchd/ovs-vswitchd.8.in   |    3 +++
> 4 files changed, 10 insertions(+), 3 deletions(-)
> 
> diff --git a/AUTHORS b/AUTHORS
> index 3364fa2..9adaa6d 100644
> --- a/AUTHORS
> +++ b/AUTHORS
> @@ -59,6 +59,7 @@ Srini Seetharaman       seethara at stanford.edu
> Stephen Hemminger       shemminger at vyatta.com
> Takayuki HAMA           t-hama at cb.jp.nec.com
> Teemu Koponen           koponen at nicira.com
> +Vishal Swarankar        vishal.swarnkar at gmail.com
> kk yap                  yapkke at stanford.edu
> 
> Thanks to all Open vSwitch contributors.  If you are not listed above
> diff --git a/README b/README
> index 55e9d9c..16f2ee6 100644
> --- a/README
> +++ b/README
> @@ -73,9 +73,9 @@ The main components of this distribution are:
> Open vSwitch also provides an OpenFlow implementation and tools for
> those interested in OpenFlow but not additional Open vSwitch features:
> 
> -    * ovs-openflowd, a program that implements a simple OpenFlow
> -      switch (without the special features provided by ovs-vswitchd)
> -      using the same kernel module as ovs-vswitchd.
> +    * ovs-openflowd, an alternative to ovs-vswitchd that implements a
> +      simple OpenFlow switch, without the special features provided by
> +      ovs-vswitchd.
> 
>     * ovs-controller, a simple OpenFlow controller.
> 
> diff --git a/utilities/ovs-openflowd.8.in b/utilities/ovs-openflowd.8.in
> index 4c10d8d..30b3705 100644
> --- a/utilities/ovs-openflowd.8.in
> +++ b/utilities/ovs-openflowd.8.in
> @@ -16,6 +16,9 @@ The \fBovs\-openflowd\fR program implements an OpenFlow switch using a
> flow-based datapath.  \fBovs\-openflowd\fR connects to one or more
> OpenFlow controllers over TCP or SSL.
> .PP
> +For a more powerful alternative to \fBovs\-openflowd\fR, see
> +\fBovs\-vswitchd\fR(8).  Do not run both daemons at the same time.
> +.PP
> The mandatory \fIdatapath\fR argument argument specifies the local datapath
> to relay.  It takes one of the following forms:
> .
> diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
> index 42282c1..e59893f 100644
> --- a/vswitchd/ovs-vswitchd.8.in
> +++ b/vswitchd/ovs-vswitchd.8.in
> @@ -67,6 +67,9 @@ Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
> A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
> to the maximum number of supported Open vSwitch datapaths.
> .PP
> +\fBovs\-vswitchd\fR provides all the features of \fBovs-openflowd\fR,
> +and more.  Do not run both daemons at the same time.
> +.PP
> \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
> itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
> managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
> -- 
> 1.7.1
>