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::bgpcep/odl-bgpcep-bgp-all-dev.adoc[BGP]
  58
  59 include::capwap/capwap-dev.adoc[CAPWAP]
  60
  61 include::controller/controller.adoc[Controller]
  62
  63 include::didm/didm-dev.adoc[]
  64
  65 include::dlux/dlux-core-dev.adoc[]
  66
  67 include::iotdm/iotdm-dev.adoc[]
  68
  69 include::l2switch/l2switch-dev.adoc[]
  70
  71 include::lacp/lacp-dev.adoc[]
  72
  73 include::controller/netconf/odl-netconf-dev.adoc[]
  74
  75 include::nic/nic-dev.adoc[]
  76
  77 include::neutron/neutron.adoc[]
  78
  79 include::sdninterfaceapp/odl-sdninterfaceapp-all-dev.adoc[]
  80
  81 include::openflowjava/odl-openflowjava-protocol-dev.adoc[]
  82
  83 include::opflex/agent-ovs-dev.adoc[]
  84
  85 include::opflex/genie-dev.adoc[]
  86
  87 include::opflex/libopflex-dev.adoc[]
  88
  89 include::ovsdb/ovsdb-developer.adoc[]
  90
  91 include::bgpcep/odl-bgpcep-pcep-all-dev.adoc[PCEP]
  92
  93 include::packetcable/packetcable-dev.adoc[Packet Cable PCMM Southbound Plugin]
  94
  95 // commenting this out as it contains no content
  96 //include::reservation/reservation-dev.adoc[]
  97
  98 include::sfc/sfc.adoc[]
  99
 100 include::sxp/odl-sxp-dev.adoc[]
 101
 102 include::tcpmd5/odl-tcpmd5-all-dev.adoc[TCP-MD5]
 103
 104 include::topoprocessing/odl-topoprocessing-framework-dev.adoc[]
 105
 106 include::ttp/ttp-model-dev.adoc[]
 107
 108 include::ttp/ttp-cli-tools-dev.adoc[]
 109
 110 include::usc/odl-usc-channel-dev.adoc[]
 111
 112 include::vtn/vtn-dev.adoc[]
 113
 114 include::yangtools/yangtools.adoc[]
 115
 116 :numbered!:
 117
 118 ///////
 119 [appendix]
 120 Example Appendix
 121 ----------------
 122 One or more optional appendixes go here at section level 1.
 123
 124 Appendix Sub-section
 125 ~~~~~~~~~~~~~~~~~~~
 126 Sub-section body.
 127
 128
 129 [glossary]
 130 Example Glossary
 131 ----------------
 132 Glossaries are optional. Glossaries entries are an example of a style
 133 of AsciiDoc labeled lists.
 134
 135 [glossary]
 136 A glossary term::
 137   The corresponding (indented) definition.
 138
 139 A second glossary term::
 140   The corresponding (indented) definition.
 141
 142
 143 [colophon]
 144 Example Colophon
 145 ----------------
 146 Text at the end of a book describing facts about its production.
 147
 148
 149 [index]
 150 Example Index
 151 -------------
 152 ///////
 153
 154 ////////////////////////////////////////////////////////////////
 155 The index is normally left completely empty, it's contents being
 156 generated automatically by the DocBook toolchain.
 157 ////////////////////////////////////////////////////////////////