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 include::section_Git_and_Gerrit_Setup.adoc[]
  40
  41 include::section_Hacking_from_CLI.adoc[]
  42
  43 = Project-Specific Development Guides
  44
  45 include::aaa.adoc[]
  46
  47 include::bgpcep/odl-bgpcep-bgp-all-dev.adoc[BGP]
  48
  49 include::bgpcep/odl-bgpcep-pcep-all-dev.adoc[PCEP]
  50
  51 include::controller.adoc[]
  52
  53 include::defense4all.adoc[]
  54
  55 include::dlux.adoc[]
  56
  57 include::groupbasedpolicy.adoc[]
  58
  59 include::iotdm/iotdm-dev.adoc[]
  60
  61 include::l2switch.adoc[]
  62
  63 include::lacp/lacp-dev.adoc[]
  64
  65 include::lispflow.adoc[]
  66
  67 include::nic/nic-model-dev.adoc[]
  68
  69 include::odlsdni.adoc[]
  70
  71 include::openflowlibrary.adoc[]
  72
  73 include::openflowplugin.adoc[]
  74
  75 include::ovsdb/ovsdb-developer.adoc[]
  76
  77 include::pcmm.adoc[]
  78
  79 include::plugin2oc.adoc[]
  80
  81 include::reservation/reservation-dev.adoc[]
  82
  83 include::sfc/sfc.adoc[]
  84
  85 include::snbi.adoc[]
  86
  87 include::snmp4sdn.adoc[]
  88
  89 include::tcmpd5/odl-tcpmd5-all-dev.adoc[TCP-MD5]
  90
  91 include::ttp/ttp-model-dev.adoc[]
  92
  93 include::ttp/ttp-cli-tools-dev.adoc[]
  94
  95 include::usc/odl-usc-channel-dev.adoc[USC]
  96
  97 include::capwap/capwap-dev.adoc[CAPWAP]
  98
  99 include::VTN_developer_guide.adoc[]
 100
 101 include::yangtools.adoc[]
 102
 103 :numbered!:
 104
 105 ///////
 106 [appendix]
 107 Example Appendix
 108 ----------------
 109 One or more optional appendixes go here at section level 1.
 110
 111 Appendix Sub-section
 112 ~~~~~~~~~~~~~~~~~~~
 113 Sub-section body.
 114
 115
 116 [glossary]
 117 Example Glossary
 118 ----------------
 119 Glossaries are optional. Glossaries entries are an example of a style
 120 of AsciiDoc labeled lists.
 121
 122 [glossary]
 123 A glossary term::
 124   The corresponding (indented) definition.
 125
 126 A second glossary term::
 127   The corresponding (indented) definition.
 128
 129
 130 [colophon]
 131 Example Colophon
 132 ----------------
 133 Text at the end of a book describing facts about its production.
 134
 135
 136 [index]
 137 Example Index
 138 -------------
 139 ///////
 140
 141 ////////////////////////////////////////////////////////////////
 142 The index is normally left completely empty, it's contents being
 143 generated automatically by the DocBook toolchain.
 144 ////////////////////////////////////////////////////////////////