Adding OpenFlow Plugin Lithium developer guide outline

Patch Set 4: moving to master from stable/lithium and making the text
             not be release-specific to Lithium.

Change-Id: Id4bc25acbeeecd75db9712d8178f11e90c312335
Signed-off-by: Colin Dixon <colin@colindixon.com>

diff --git a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
index 743699d5924fc34a5c03e04217ba445711862517..4f7d7691a0c4505463575df372251e50070b4795 100644 (file)
--- a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
+++ b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
@@ -86,6 +86,8 @@ include::sdninterfaceapp/odl-sdninterfaceapp-all-dev.adoc[]
 
 include::openflowjava/odl-openflowjava-protocol-dev.adoc[]
 
+include::openflowplugin/odl-ofp-developer-guide.adoc[]
+
 include::opflex/agent-ovs-dev.adoc[]
 
 include::opflex/genie-dev.adoc[]

diff --git a/manuals/developer-guide/src/main/asciidoc/openflowplugin/odl-ofp-developer-guide.adoc b/manuals/developer-guide/src/main/asciidoc/openflowplugin/odl-ofp-developer-guide.adoc
new file mode 100644 (file)
index 0000000..d50e2e5
--- /dev/null
+++ b/manuals/developer-guide/src/main/asciidoc/openflowplugin/odl-ofp-developer-guide.adoc
@@ -0,0 +1,49 @@
+[[openflow-plugin-project-developer-guide]]
+== OpenFlow Plugin Project Developer Guide
+
+This section covers topics which are developer specific and which have not been
+covered in the user guide. Please see the Lithium OpenFlow plugin user
+guide first.
+
+It can be found on https://www.opendaylight.org/downloads[the OpenDaylight software download page].
+
+// include::odl-ofp-sequence-diagram.adoc[]
+
+// include::odl-ofp-config-subsystem.adoc[]
+
+// include::odl-ofp-message-spy.adoc[]
+
+// * OpenDaylight_OpenFlow_Plugin:Backlog:Extensibility[Extensibility Framework]
+
+// include::odl-ofp-yang-models.adoc[]
+
+// include::odl-ofp-feature-tree.adoc[]
+
+// include::odl-ofp-wiring-up-notifications.adoc[]
+
+=== Message Order Preservation
+
+While the Helium release of OpenFlow Plugin relied on queues to ensure messages were delivered in order, subsequent releases instead ensure that all the messages from a given device are delivered using the same thread and thus message order is guaranteed without queues. The OpenFlow plugin allocates a number of threads equal to twice the number of processor cores on machine it is run, e.g., 8 threads if the machine has 4 cores.
+
+NOTE:
+While each device is assigned to one thread, multiple devices can be assigned to the same thread.
+
+// == Tutorial / How-To
+
+// missing content
+
+// * OpenDaylight_OpenFlow_Plugin::Build_Instructions[Build Instructions]
+
+// * OpenDaylight_OpenFlow_Plugin::MininetFromScratch[Mininet from scratch]
+
+// * OpenDaylight_OpenFlow_Plugin::Mininet with multiple controllers[Mininet with multiple controllers]
+
+// * OpenDaylight_OpenFlow_Plugin:Coding_Hints[Coding hints]
+
+// * OpenDaylight_OpenFlow_Plugin::Wiring up Notifications[Wiring up Notifications]
+
+// * OpenDaylight_OpenFlow_Plugin::Python_test_scripts[Python test-scripts]
+
+// * OpenDaylight_OpenFlow_Plugin:Robot_Framework_Tests[Setup robot testing environment]
+
+// * OpenDaylight_OpenFlow_Plugin::LiProposal_dev_setup[Lithium proposal - dev setup]