From: Ihar Hrachyshka <ihrachys@redhat.com>
Date: Thu, 2 Jul 2015 15:42:07 +0000 (+0300)
Subject: Start documenting potential API breakages in devref:neutron_api
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=d06990b8a548a63df5e50e9e75b59a5bbe0ba5b0;p=openstack-build%2Fneutron-build.git

Start documenting potential API breakages in devref:neutron_api

Change-Id: I2ceb9e347ea0687e93b766d58601cd86561d1e2b
---

diff --git a/doc/source/devref/neutron_api.rst b/doc/source/devref/neutron_api.rst
index 92e116d25..6479b6d8b 100644
--- a/doc/source/devref/neutron_api.rst
+++ b/doc/source/devref/neutron_api.rst
@@ -18,3 +18,18 @@ itself. (The only exception is made for advanced service repositories that are
 tightly controlled by neutron community.) Long story short, if your repository
 uses those modules, please switch to corresponding oslo libraries or use your
 own copy of oslo-incubator files.
+
+
+Breakages
+---------
+
+Neutron API is not very stable, and there are cases when a desired change in
+neutron tree is expected to trigger breakage for one or more external
+repositories under the neutron tent. Below you can find a list of known
+incompatible changes that could or are known to trigger those breakages.
+
+* change: oslo.service adopted.
+
+  - commit: 6e693fc91dd79cfbf181e3b015a1816d985ad02c
+  - solution: switch using oslo_service.* namespace; stop using ANY neutron.openstack.* contents.
+  - severity: low (plugins must not rely on that subtree).