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::lispflow.adoc[]
  64
  65 include::nic/nic-model-dev.adoc[]
  66
  67 include::odlsdni.adoc[]
  68
  69 include::openflowlibrary.adoc[]
  70
  71 include::openflowplugin.adoc[]
  72
  73 include::ovsdb.adoc[]
  74
  75 include::ovsdb/ovsdb-southbound-developer.adoc[]
  76
  77 include::pcmm.adoc[]
  78
  79 include::plugin2oc.adoc[]
  80
  81 include::sfc.adoc[]
  82
  83 include::snbi.adoc[]
  84
  85 include::snmp4sdn.adoc[]
  86
  87 include::tcmpd5/odl-tcpmd5-all-dev.adoc[TCP-MD5]
  88
  89 include::ttp/ttp-model-dev.adoc[]
  90
  91 include::ttp/ttp-cli-tools-dev.adoc[]
  92
  93 include::usc/odl-usc-channel-dev.adoc[USC]
  94
  95 include::VTN_developer_guide.adoc[]
  96
  97 include::yangtools.adoc[]
  98
  99 :numbered!:
 100
 101 ///////
 102 [appendix]
 103 Example Appendix
 104 ----------------
 105 One or more optional appendixes go here at section level 1.
 106
 107 Appendix Sub-section
 108 ~~~~~~~~~~~~~~~~~~~
 109 Sub-section body.
 110
 111
 112 [glossary]
 113 Example Glossary
 114 ----------------
 115 Glossaries are optional. Glossaries entries are an example of a style
 116 of AsciiDoc labeled lists.
 117
 118 [glossary]
 119 A glossary term::
 120   The corresponding (indented) definition.
 121
 122 A second glossary term::
 123   The corresponding (indented) definition.
 124
 125
 126 [colophon]
 127 Example Colophon
 128 ----------------
 129 Text at the end of a book describing facts about its production.
 130
 131
 132 [index]
 133 Example Index
 134 -------------
 135 ///////
 136
 137 ////////////////////////////////////////////////////////////////
 138 The index is normally left completely empty, it's contents being
 139 generated automatically by the DocBook toolchain.
 140 ////////////////////////////////////////////////////////////////