openstack
/
neutron
Code Issues Proposed changes

Objects: Add README for neutron/objects directory tree 

As we have started oslo.versionedobjects implementation (OVO),
there are lots of Objects that need implementation. This README
in the root dir will give some guidance to keep the tree organized.

Change-Id: I9253a243f37e4695290162bee7a41149c5f665fa
This commit is contained in:
Ankur Gupta 2016-08-08 14:46:09 -05:00 committed by Ankur
parent 5202e01da6
commit 1762dc701b
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
neutron/objects/README.rst Normal file
View File

@ -0,0 +1,22 @@
===============
Neutron Objects
===============
Directory
=========
This directory is designed to contain all modules which have objects definitions
shipped with core Neutron. The files and directories located inside
of this directory should follow the guidelines below.
Structure
---------
The Neutron objects tree should have the following structure:
* The expected directory structure is flat, except for the ML2 plugins. All ML2
plugin objects should fall under the plugins subdirectory (i.e. plugins/ml2/gre_allocation).
* Module names should use singular forms for nouns (network.py, not networks.py).