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 = Project-Specific Development Guides
  52
  53 include::controller/controller.adoc[Controller]
  54
  55 include::bgpcep/odl-bgpcep-bgp-all-dev.adoc[BGP]
  56
  57 include::bgpcep/odl-bgpcep-pcep-all-dev.adoc[PCEP]
  58
  59 include::iotdm/iotdm-dev.adoc[]
  60
  61 include::lacp/lacp-dev.adoc[]
  62
  63 include::l2switch/l2switch-dev.adoc[]
  64
  65 include::nic/nic-dev.adoc[]
  66
  67 include::neutron/neutron.adoc[]
  68
  69 include::openflowjava/odl-openflowjava-protocol-dev.adoc[]
  70
  71 include::ovsdb/ovsdb-developer.adoc[]
  72
  73 include::reservation/reservation-dev.adoc[]
  74
  75 include::sfc/sfc.adoc[]
  76
  77 include::sdninterfaceapp/odl-sdninterfaceapp-all-dev.adoc[]
  78
  79 include::tcpmd5/odl-tcpmd5-all-dev.adoc[TCP-MD5]
  80
  81 include::topoprocessing/odl-topoprocessing-framework-dev.adoc[]
  82
  83 include::ttp/ttp-model-dev.adoc[]
  84
  85 include::ttp/ttp-cli-tools-dev.adoc[]
  86
  87 include::usc/odl-usc-channel-dev.adoc[]
  88
  89 include::didm/didm-dev.adoc[]
  90
  91 include::vtn/vtn-dev.adoc[]
  92
  93 :numbered!:
  94
  95 ///////
  96 [appendix]
  97 Example Appendix
  98 ----------------
  99 One or more optional appendixes go here at section level 1.
 100
 101 Appendix Sub-section
 102 ~~~~~~~~~~~~~~~~~~~
 103 Sub-section body.
 104
 105
 106 [glossary]
 107 Example Glossary
 108 ----------------
 109 Glossaries are optional. Glossaries entries are an example of a style
 110 of AsciiDoc labeled lists.
 111
 112 [glossary]
 113 A glossary term::
 114   The corresponding (indented) definition.
 115
 116 A second glossary term::
 117   The corresponding (indented) definition.
 118
 119
 120 [colophon]
 121 Example Colophon
 122 ----------------
 123 Text at the end of a book describing facts about its production.
 124
 125
 126 [index]
 127 Example Index
 128 -------------
 129 ///////
 130
 131 ////////////////////////////////////////////////////////////////
 132 The index is normally left completely empty, it's contents being
 133 generated automatically by the DocBook toolchain.
 134 ////////////////////////////////////////////////////////////////