openstack/neutron-lib
Code Issues Proposed changes

remove use of legacy modules

Browse Source 
The notion of legacy modules has been in neutron-lib from the start and
the intention was to place them under neutron_lib.legacy.*
However we've been working on neutron-lib for a few years now and have
never used legacy modules. IMO it's safe to assume we won't use them
in neutron-lib.

This patch removes the empty sub-package neutron_lib.legacy and removes
the discussion of them from the docs.

Change-Id: Ie7a4cf65e37c3f2dcd3446232dba9695f41e314d
This commit is contained in:
Boden R 2019-04-10 10:47:02 -06:00
parent 3fd0a3c4d7
commit ea53b0ecd1
3 changed files with 0 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/source/contributor/conventions.rst
View File

@ -48,31 +48,3 @@ DO NOT USE THEM. THEY WILL CHANGE.
Private interfaces in this library will always have a leading underscore, Private interfaces in this library will always have a leading underscore,
on the module or function name. on the module or function name.
Legacy Modules
--------------
This library has a special namespace called neutron_lib.legacy.
Anything in this directory will likely get a new interface in the top-level
library sometime in the near future, and then a debtcollector deprecation
notice. Expect to get current cycle plus one release of maintenance at that
point, and then they will be removed.
Why this intermediary step? Because neutron has some serious dependency
issues with its subprojects that need breaking, we do not want to rush
some of the refactors to our interfaces that need to happen, we have
limited resources, but we still need to make addressing those dependency
issues a high priority.
The legacy module is for those existing modules in neutron that are in
wide use by subprojects, but which are not super interfaces. The legacy
submodule is for routines that will still be maintained with a long-term
backwards compatibility interface contract, but which are not considered
"library worthy" by the neutron core team.
This can easily be abused as a kitchen sink to just move stuff and make
fast progress. Please do not do this, and do not expect this kind of thing
to be favorably reviewed. Good candidates for this area are things that
we want to refactor, but are lower priority, AND they have been around for
a long time with no changes (i.e. an existing history of stability).

7
neutron_lib/legacy/README.rst
View File

@ -1,7 +0,0 @@
===========================
neutron-lib legacy routines
===========================
This is a special namespace with lower deprecation policy standards,
and specific rules for its use. Please refer to the 'Legacy Modules'
section of this library's 'conventions' document for more information.

0
neutron_lib/legacy/__init__.py
View File