ofproto: Rename "private.h" to "ofproto->provider.h".
authorJustin Pettit <jpettit@nicira.com>
Fri, 1 Jul 2011 21:13:56 +0000 (14:13 -0700)
committerJustin Pettit <jpettit@nicira.com>
Fri, 1 Jul 2011 21:13:56 +0000 (14:13 -0700)
To be more consistent with other providers, rename "private.h" to
"ofproto-provider.h".

PORTING
ofproto/automake.mk
ofproto/connmgr.c
ofproto/fail-open.c
ofproto/in-band.c
ofproto/ofproto-dpif.c
ofproto/ofproto-provider.h [moved from ofproto/private.h with 99% similarity]
ofproto/ofproto.c

diff --git a/PORTING b/PORTING
index 3dd0bfc..1ac1c63 100644 (file)
--- a/PORTING
+++ b/PORTING
@@ -160,9 +160,9 @@ ofproto Providers
 
 An "ofproto provider" is what ofproto uses to directly monitor and
 control an OpenFlow-capable switch.  struct ofproto_class, in
-ofproto/private.h, defines the interfaces to implement an ofproto
-provider for new hardware or software.  That structure contains many
-function pointers, each of which has a comment that is meant to
+ofproto/ofproto-provider.h, defines the interfaces to implement an
+ofproto provider for new hardware or software.  That structure contains
+many function pointers, each of which has a comment that is meant to
 describe its behavior in detail.  If the requirements are unclear,
 please report this as a bug.
 
index 9ce40ab..df83aef 100644 (file)
@@ -23,10 +23,10 @@ ofproto_libofproto_a_SOURCES = \
        ofproto/ofproto-dpif.c \
        ofproto/ofproto-dpif-sflow.c \
        ofproto/ofproto-dpif-sflow.h \
+       ofproto/ofproto-provider.h \
        ofproto/pktbuf.c \
        ofproto/pktbuf.h \
        ofproto/pinsched.c \
-       ofproto/pinsched.h \
-       ofproto/private.h
+       ofproto/pinsched.h
 
 EXTRA_DIST += ofproto/ofproto-unixctl.man
index 7776c88..44e1b28 100644 (file)
 #include "odp-util.h"
 #include "ofp-util.h"
 #include "ofpbuf.h"
+#include "ofproto-provider.h"
 #include "pinsched.h"
 #include "poll-loop.h"
 #include "pktbuf.h"
-#include "private.h"
 #include "rconn.h"
 #include "shash.h"
 #include "timeval.h"
index 197e518..541bb05 100644 (file)
@@ -26,9 +26,9 @@
 #include "ofp-util.h"
 #include "ofpbuf.h"
 #include "ofproto.h"
+#include "ofproto-provider.h"
 #include "pktbuf.h"
 #include "poll-loop.h"
-#include "private.h"
 #include "rconn.h"
 #include "timeval.h"
 #include "vconn.h"
index 14cfa04..ae1f1b1 100644 (file)
 #include "odp-util.h"
 #include "ofproto.h"
 #include "ofpbuf.h"
+#include "ofproto-provider.h"
 #include "openflow/openflow.h"
 #include "packets.h"
 #include "poll-loop.h"
-#include "private.h"
 #include "timeval.h"
 #include "vlog.h"
 
index 1e77cda..7264355 100644 (file)
@@ -16,7 +16,7 @@
 
 #include <config.h>
 
-#include "ofproto/private.h"
+#include "ofproto/ofproto-provider.h"
 
 #include <errno.h>
 
similarity index 99%
rename from ofproto/private.h
rename to ofproto/ofproto-provider.h
index a5bd17e..62fb035 100644 (file)
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef OFPROTO_PRIVATE_H
-#define OFPROTO_PRIVATE_H 1
+#ifndef OFPROTO_OFPROTO_PROVIDER_H
+#define OFPROTO_OFPROTO_PROVIDER_H 1
 
 /* Definitions for use within ofproto. */
 
@@ -923,4 +923,4 @@ void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
 bool ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
 void ofproto_flush_flows(struct ofproto *);
 
-#endif /* ofproto/private.h */
+#endif /* ofproto/ofproto-provider.h */
index ac243cf..201488d 100644 (file)
 #include "ofp-print.h"
 #include "ofp-util.h"
 #include "ofpbuf.h"
+#include "ofproto-provider.h"
 #include "openflow/nicira-ext.h"
 #include "openflow/openflow.h"
 #include "packets.h"
 #include "pinsched.h"
 #include "pktbuf.h"
 #include "poll-loop.h"
-#include "private.h"
 #include "shash.h"
 #include "sset.h"
 #include "timeval.h"
@@ -1369,8 +1369,8 @@ ofproto_rule_destroy__(struct rule *rule)
 /* This function allows an ofproto implementation to destroy any rules that
  * remain when its ->destruct() function is called.  The caller must have
  * already uninitialized any derived members of 'rule' (step 5 described in the
- * large comment in ofproto/private.h titled "Life Cycle").  This function
- * implements steps 6 and 7.
+ * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
+ * This function implements steps 6 and 7.
  *
  * This function should only be called from an ofproto implementation's
  * ->destruct() function.  It is not suitable elsewhere. */
@@ -2800,8 +2800,8 @@ ofoperation_destroy(struct ofoperation *op)
  * If 'op' is a "delete flow" operation, 'error' must be 0.  That is, flow
  * deletions are not allowed to fail.
  *
- * Please see the large comment in ofproto/private.h titled "Asynchronous
- * Operation Support" for more information. */
+ * Please see the large comment in ofproto/ofproto-provider.h titled
+ * "Asynchronous Operation Support" for more information. */
 void
 ofoperation_complete(struct ofoperation *op, int error)
 {