manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc

   1 [[bk-user-guide]]
   2 = OpenDaylight Developer Guide
   3 :docinfo:
   4
   5 ///////
   6 [dedication]
   7 Example Dedication
   8 ------------------
   9 Optional dedication.
  10
  11 This document is an AsciiDoc book skeleton containing briefly
  12 annotated example elements plus a couple of example index entries and
  13 footnotes.
  14
  15 Books are normally used to generate DocBook markup and the titles of
  16 the preface, appendix, bibliography, glossary and index sections are
  17 significant ('specialsections').
  18
  19
  20 [preface]
  21 Example Preface
  22 ---------------
  23 Optional preface.
  24
  25 Preface Sub-section
  26 ~~~~~~~~~~~~~~~~~~~
  27 Preface sub-section body.
  28 ///////
  29
  30 //////////////////////////
  31 Please note and leave the blank line between include statements here.
  32
  33 It is a defensive measure to prevent individual projects' .adoc files
  34 from eating the next section if they forget to leave a blank line at
  35 the end of their file.
  36 //////////////////////////
  37 = Overview
  38
  39 // FIXME: Should we use introduction from user manual / installation guide?
  40 //        are this prerequisites for developers guide? If so, we should document
  41 //        that explicitly here so we do not need to repeat same text
  42 //          over-and-over
  43
  44 // FIXME: section_Git_and_Gerrit_Setup.adoc and section_Hacking_from_CLI.adoc
  45 //        is much more contributor style documentation and not Developer
  46 //        documentation for folks which wants to build on top of OpenDaylight.
  47 include::section_Git_and_Gerrit_Setup.adoc[]
  48
  49 include::section_Hacking_from_CLI.adoc[]
  50
  51 include::developing-app.adoc[]
  52
  53 = Project-Specific Development Guides
  54
  55 include::alto/alto-developer-guide.adoc[ALTO]
  56
  57 include::armoury/odl-armoury-dev.adoc[ARMOURY]
  58
  59 include::bgpcep/odl-bgpcep-bgp-all-dev.adoc[BGP]
  60
  61 include::bgpcep/odl-bgpcep-bmp-dev.adoc[BGP]
  62
  63 include::capwap/capwap-dev.adoc[CAPWAP]
  64
  65 include::controller/controller.adoc[Controller]
  66
  67 include::didm/didm-dev.adoc[]
  68
  69 include::dlux/dlux-core-dev.adoc[]
  70
  71 include::iotdm/iotdm-dev.adoc[]
  72
  73 include::l2switch/l2switch-dev.adoc[]
  74
  75 include::lacp/lacp-dev.adoc[]
  76
  77 include::messaging4transport/messaging4transport-developer.adoc[]
  78
  79 include::controller/netconf/odl-netconf-dev.adoc[]
  80
  81 include::nic/nic-dev.adoc[]
  82
  83 include::nemo/odl-nemo-engine-dev.adoc[]
  84
  85 include::netide/netide-developer-guide.adoc[]
  86
  87 include::neutron/neutron.adoc[]
  88
  89 include::sdninterfaceapp/odl-sdninterfaceapp-all-dev.adoc[]
  90
  91 include::openflowjava/odl-openflowjava-protocol-dev.adoc[]
  92
  93 include::openflowplugin/odl-ofp-developer-guide.adoc[]
  94
  95 include::opflex/agent-ovs-dev.adoc[]
  96
  97 include::opflex/genie-dev.adoc[]
  98
  99 include::opflex/libopflex-dev.adoc[]
 100
 101 include::ovsdb/ovsdb-developer.adoc[]
 102
 103 include::bgpcep/odl-bgpcep-pcep-all-dev.adoc[PCEP]
 104
 105 include::packetcable/packetcable-dev.adoc[Packet Cable PCMM Southbound Plugin]
 106
 107 // commenting this out as it contains no content
 108 //include::reservation/reservation-dev.adoc[]
 109
 110 include::sfc/sfc.adoc[]
 111
 112 include::snmp4sdn/snmp4sdn-developer.adoc[SNMP4SDN]
 113
 114 include::sxp/odl-sxp-dev.adoc[]
 115
 116 include::tcpmd5/odl-tcpmd5-all-dev.adoc[TCP-MD5]
 117
 118 include::topoprocessing/odl-topoprocessing-framework-dev.adoc[]
 119
 120 include::ttp/ttp-model-dev.adoc[]
 121
 122 include::ttp/ttp-cli-tools-dev.adoc[]
 123
 124 include::usc/odl-usc-channel-dev.adoc[]
 125
 126 include::vtn/vtn-dev.adoc[]
 127
 128 include::yangtools/yangtools.adoc[]
 129
 130 include::yang-push/odl-yang-push-dev.adoc[YANG-PUSH]
 131
 132 :numbered!:
 133
 134 ///////
 135 [appendix]
 136 Example Appendix
 137 ----------------
 138 One or more optional appendixes go here at section level 1.
 139
 140 Appendix Sub-section
 141 ~~~~~~~~~~~~~~~~~~~
 142 Sub-section body.
 143
 144
 145 [glossary]
 146 Example Glossary
 147 ----------------
 148 Glossaries are optional. Glossaries entries are an example of a style
 149 of AsciiDoc labeled lists.
 150
 151 [glossary]
 152 A glossary term::
 153   The corresponding (indented) definition.
 154
 155 A second glossary term::
 156   The corresponding (indented) definition.
 157
 158
 159 [colophon]
 160 Example Colophon
 161 ----------------
 162 Text at the end of a book describing facts about its production.
 163
 164
 165 [index]
 166 Example Index
 167 -------------
 168 ///////
 169
 170 ////////////////////////////////////////////////////////////////
 171 The index is normally left completely empty, it's contents being
 172 generated automatically by the DocBook toolchain.
 173 ////////////////////////////////////////////////////////////////