Merge branch 'master' of github.com:midokura/openfaucet

AUTHORS

@@ -1,7 +1,10 @@
 Authors of OpenFaucet.
 
-OpenFaucet was written by Romain Lenglet.
-Other contributers are Jacob Mandelson.
+OpenFaucet's primary maintainers are:
+Romain Lenglet              romain.lenglet@berabera.info        2011-02-09
+
+Other contributors are:
+Jacob Mandelson             jacob@mandelson.org                 2011-03-08
 
 ========================================================================
 

ChangeLog

@@ -1,3 +1,74 @@
+2011-03-22  Romain Lenglet  <romain.lenglet@berabera.info>
+
+	* configure.ac, NEWS: Set the version to 1.1~pre1, and prepare
+	NEWS for future changes.
+
+	* configure.ac: Set the version to 1.0.
+
+	* NEWS: Add empty NEWS file.
+
+	* docs/install.rst.in: Add a link to the releases index page.
+
+	* docs/install.rst.in, index.rst, configure.ac, docs/Makefile.am:
+	Add documentation for installing and building OpenFaucet.
+
+	* docs/index.rst: Shorten titles in table of contents.
+
+	* docs/match.rst, docs/index.rst, docs/Makefile.am: Add
+	documentation for OpenFlow flow matches.
+
+2011-03-21  Romain Lenglet  <romain.lenglet@berabera.info>
+
+
+	* docs/index.rst, docs/Makefile.am, docs/error.rst: Add
+	documentation for OpenFlow errors.
+
+	* src/openfaucet/ofproto.py, src/openfaucet/ofcontroller.py,
+	docs/controller.rst: Add method raise_error_with_request into
+	IOpenflowControllerStub. Add documentation for it.
+
+	* src/test_all.py.in, src/openfaucet/*.py: Follow PEP8 style:
+	reindent all Python sources with 4 spaces, put spaces around all
+	operators, etc. Move module documentation from comments into
+	docstrings.
+
+2011-03-17  Romain Lenglet  <romain.lenglet@berabera.info>
+
+	* src/openfaucet/test_ofprotoops.py,
+	src/openfaucet/test_ofcontroller.py: Use LoopbackTransports to
+	exchange messages with a peer mock protocol, to simplify
+	unittests.
+
+	* src/openfaucet/mock_ofproto.py: Define class LoopbackTransport.
+
+	* src/test_all.py.in: Fix logging setup.
+
+	* src/openfaucet/ofproto.py, src/openfaucet/ofprotoops.py,
+	src/openfaucet/ofcontroller.py: Add INFO-level logging. Log the
+	configuration at INFO level.
+
+	* src/openfaucet/buffer.py, src/openfaucet/test_buffer.py,
+	src/openfaucet/test_ofconfig.py: Raise IndexErrors instead of
+	AssertionErrors in ReceiveBuffer's methods.
+
+	* src/openfaucet/ofproto.py, src/openfaucet/midokura.py,
+	src/openfaucet/mock_vendor.py: Define the IOpenflowVendorHandler
+	and IOpenflowVendorHandlerStub interfaces.  Rename "buffer" args
+	into "buf" to prevent shadowing Python's "buffer" keyword.
+
+2011-03-16  Romain Lenglet  <romain.lenglet@berabera.info>
+
+	* src/openfaucet/ofproto.py: Dispatch on message type using a dict
+	instead of a series of ifs.
+
+2011-03-14  Romain Lenglet  <romain.lenglet@berabera.info>
+
+	* configure.ac: Replace the bug report email address by
+	openfaucet-bug@googlegroups.com.
+
+	* AUTHORS: Fix the formatting of contributors list to follow the
+	same conventions as GNU projects' AUTHORS files.
+
 2011-03-08  Jacob Mandelson  <jacob@mandelson.org>
 
 	* src/openfaucet/midokura.py,

NEWS

@@ -0,0 +1,18 @@
+OpenFaucet NEWS - User visible changes.
+
+* Noteworthy changes in release ?.? (????-??-??) [?]
+
+
+Copyright 2011 Midokura KK
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

configure.ac

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 AC_PREREQ(2.64)
-AC_INIT(OpenFaucet, 0.1~pre1, romain.lenglet@berabera.info, openfaucet)
+AC_INIT(OpenFaucet, 1.1~pre1, openfaucet-bug@googlegroups.com, openfaucet)
 AC_COPYRIGHT([Copyright 2011 Midokura KK])
 AC_CONFIG_AUX_DIR(config)
 AC_CONFIG_MACRO_DIR(config)
@@ -47,6 +47,7 @@ AS_IF([test "x$ac_cv_path_PDFLATEX" = xnotfound],
 AC_CONFIG_FILES([Makefile
 docs/Makefile
 docs/conf.py
+docs/install.rst
 src/Makefile])
 
 AC_OUTPUT

debian/changelog

@@ -1,3 +1,15 @@
+openfaucet (1.1~pre1) unstable; urgency=low
+
+  * Minor fixes.
+
+ -- Romain Lenglet <romain.lenglet@berabera.info>  Tue, 22 Mar 2011 15:46:44 +0100
+
+openfaucet (1.0) unstable; urgency=low
+
+  * Update to released version 1.0.
+
+ -- Romain Lenglet <romain.lenglet@berabera.info>  Tue, 22 Mar 2011 15:08:35 +0100
+
 openfaucet (0.1~pre1) unstable; urgency=low
 
   * Initial Release.

debian/control

@@ -5,7 +5,7 @@ Maintainer: Romain Lenglet <romain.lenglet@berabera.info>
 Build-Depends: debhelper (>= 7.0.50~), autotools-dev, python,
  python-sphinx, python-support, python-unittest2
 Standards-Version: 3.9.1.0
-Homepage: https://github.com/midokura/openfaucet
+Homepage: http://midokura.github.com/openfaucet/index.html
 Vcs-Git: https://github.com/midokura/openfaucet.git
 Vcs-Browser: https://github.com/midokura/openfaucet
 

debian/python-openfaucet-doc.doc-base

@@ -0,0 +1,11 @@
+Document: openfaucet
+Title: OpenFaucet documentation
+Author: Romain Lenglet
+Abstract: OpenFaucet is an implementation of the OpenFlow protocol in Python.
+ This documentation describes how to use OpenFaucet to develop OpenFlow
+ controllers.
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-openfaucet-doc/html/index.html
+Files: /usr/share/doc/python-openfaucet-doc/html/*.html

docs/Makefile.am

@@ -14,13 +14,18 @@
 
 # Makefile for Sphinx documentation.
 
-SPHINXDATA = \
+dist_noinst_DATA = \
 	index.rst \
 	controller.rst \
+	match.rst \
 	config.rst \
-	action.rst
+	action.rst \
+	error.rst
 
-dist_noinst_DATA = $(SPHINXDATA)
+EXTRA_DIST = install.rst.in
+
+SPHINXDATA = $(dist_noinst_DATA) \
+	install.rst
 
 SPHINXOPTS     = -q -N
 PAPEROPT       = -D latex_paper_size=a4
@@ -30,14 +35,22 @@ installdirs-local: installdirs-html-local
 
 HTMLDATA = \
 	html/index.html \
+	html/install.html \
 	html/controller.html \
+	html/match.html \
 	html/config.html \
 	html/action.html \
+	html/error.html \
 	html/genindex.html \
 	html/search.html \
 	html/searchindex.js \
 	html/_sources/index.txt \
+	html/_sources/install.txt \
 	html/_sources/controller.txt \
+	html/_sources/match.txt \
+	html/_sources/config.txt \
+	html/_sources/action.txt \
+	html/_sources/error.txt \
 	html/_static/pygments.css \
 	html/_static/searchtools.js \
 	html/_static/file.png \
@@ -51,9 +64,12 @@ HTMLDATA = \
 CLEANFILES = \
 	environment.pickle \
 	index.doctree \
+	install.doctree \
 	controller.doctree \
+	match.doctree \
 	config.doctree \
-	action.doctree
+	action.doctree \
+	error.doctree
 
 clean-local:
 	-rm -rf $(builddir)/html

docs/config.rst

@@ -74,7 +74,7 @@ instance::
 
     The number of tables supported by the datapath.
 
-   cap_*: Boolean flags indicating each the support of not of a capability:
+  cap_*: Boolean flags indicating each the support of not of a capability:
 
   .. attribute:: cap_flow_stats
 

docs/controller.rst

@@ -774,3 +774,17 @@ object.
       :type reply_more: bool
 
   .. TODO(romain): Document how to get vendor stats.
+
+  .. method:: raise_error_with_request(error_type, error_code)
+
+    Raise an :class:`~openfaucet.oferror.OpenflowError` with the
+    failed request.
+
+    The raised exception's data contains at least 64 bytes of the
+    currently handled message. This method must be called from a
+    message handling callback.
+
+    :param error_type: The error type, as one of the ``OFPET_*``
+      constants.
+    :param error_code: The error code, as one of the ``OFP*`` error code
+      constants.