docs/release-notes/index.rst

   1 #############
   2 Release Notes
   3 #############
   4
   5 Target Environment
   6 ==================
   7
   8 For Execution
   9 -------------
  10
  11 The OpenDaylight Karaf container, OSGi bundles, and Java class files
  12 are portable and should run on any Java 8-compliant JVM. Certain projects and
  13 certain features of some projects may have additional requirements.
  14
  15 For Development
  16 ---------------
  17
  18 OpenDaylight is written primarily in Java project and primarily uses
  19 Maven as a build tool Consequently the two main requirements to develop
  20 projects within OpenDaylight are:
  21
  22 * A Java 8-compliant JDK
  23 * Maven 3.5.2 or later
  24
  25 Applications and tools built on top of OpenDaylight using its REST
  26 APIs should have no special requirements beyond whatever is needed to
  27 run the application or tool and make the REST calls.
  28
  29 In some places, OpenDaylight makes use of the Xtend language. While
  30 Maven will download the appropriate tools to build this, additional
  31 plugins may be required for IDE support.
  32
  33 The projects with additional requirements for execution typically have
  34 similar or more extensive additional requirements for development. See
  35 the project-specific release notes for details.
  36
  37 Known Issues and Limitations
  38 ============================
  39
  40 Other than as noted in project-specific release notes, we know of the
  41 following limitations:
  42
  43 * Migration from prior OpenDaylight releases to |release| has not been
  44   extensively tested. The per-project release notes include migration and
  45   compatibility information when it is known.
  46
  47 Project-specific Release Notes
  48 ==============================
  49
  50 .. .. toctree::
  51 ..   :glob:
  52 ..   :maxdepth: 1
  53 ..
  54 ..   projects/*
  55
  56 `odlparent`_
  57
  58 .. _odlparent: https://git.opendaylight.org/gerrit/gitweb?p=odlparent.git;a=blob;f=NEWS.rst
  59
  60 .. Service Release Notes
  61 .. =====================
  62 ..
  63 .. .. toctree::
  64 ..   :glob:
  65 ..   :maxdepth: 2
  66 ..
  67 ..   release-notes-*