Reset mac header in flow_extract(), because it might initially be null.
[sliver-openvswitch.git] / README
diff --git a/README b/README
index cb0a9fc..a5d7a30 100644 (file)
--- a/README
+++ b/README
@@ -8,7 +8,7 @@ researchers to run experiments in live networks.  OpenFlow is based on a
 simple Ethernet flow switch that exposes a standardized interface for
 adding and removing flow entries.
 
-An OpenFlow Switch consists of three parts: (1) A "flow table" in
+An OpenFlow switch consists of three parts: (1) A "flow table" in
 which each flow entry is associated with an action telling the switch
 how to process the flow, (2) a "secure channel" connecting the switch
 to a remote process (a controller), allowing commands and packets to
@@ -16,7 +16,7 @@ be sent between the controller and the switch, and (3) an OpenFlow
 protocol implementation, providing an open and standard way for a
 controller to talk to the switch.
 
-An OpenFlow Switch can thus serve as a simple datapath element that
+An OpenFlow switch can thus serve as a simple datapath element that
 forwards packets between ports according to flow actions defined by
 the controller using OpenFlow commands.  Example actions are:
 
@@ -24,7 +24,7 @@ the controller using OpenFlow commands.  Example actions are:
     - Drop this flow's packets
     - Encapsulate and forward this flow's packets to the controller.
 
-The OpenFlow Switch is defined in detail in the OpenFlow Switch
+The OpenFlow switch is defined in detail in the OpenFlow switch
 Specification [2].
 
 What's here?
@@ -43,7 +43,7 @@ the following components:
 
        - dpctl, a tool for configuring the kernel module.
 
-The second implementation is a single user-space program, named
+The second implementation is a single userspace program, named
 "switch", that integrates all three parts of an OpenFlow switch.
 
 This distribution includes some additional software as well:
@@ -52,7 +52,7 @@ This distribution includes some additional software as well:
           OpenFlow switches, commanding them to act as regular MAC
           learning switches.
 
-        - vlogconf, a utility that can adjust the logging levels of a
+       - vlogconf, a utility that can adjust the logging levels of a
           running secchan or controller.
 
        - ofp-pki, a utility for creating and managing the public-key
@@ -61,9 +61,8 @@ This distribution includes some additional software as well:
        - A patch to tcpdump that enables it to parse OpenFlow
           messages.
 
-For installation instructions, read INSTALL.  This distribution also
-includes manpages for each of its userspace programs, in the man/
-directory.
+For installation instructions, read INSTALL.  Each userspace program
+is also accompanied by a manpage.
 
 Platform support
 ----------------
@@ -90,25 +89,16 @@ GCC is the expected compiler.
 Bugs/Shortcomings
 -----------------
 
-- The current flowtable does not support all statistics messages
-  mentioned in the Type 0 OpenFlow spec.
-
 - The flowtable does not support the "normal processing" action.
 
-- Configure/build system does not support separate build directory for
-  the datapath.  ./configure must be run from the source root.
-
-- dpctl dump-flows may freeze when large numbers of flows are in the
-  flow table.  This has no effect on the datapath.
-
 References
 ----------
 
     [1] OpenFlow: Enabling Innovation in College Networks.  Whitepaper.
-        <http://openflowswitch.org/alpha/openflow-wp-v0.1.pdf>
+        <http://openflowswitch.org/documents/openflow-wp-latest.pdf>
 
     [2] OpenFlow Switch Specification.
-        <http://openflowswitch.org/alpha/openflow-spec-v0.2.pdf>        
+        <http://openflowswitch.org/documents/openflow-spec-latest.pdf>
 
 Contact 
 -------