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