openstack
/
neutron
Code Issues Proposed changes

Merge "Objects: Add README for neutron/objects directory tree"

This commit is contained in:
Jenkins 2016-10-13 04:53:14 +00:00 committed by Gerrit Code Review
parent 9806288cd7 1762dc701b
commit 2ad5208854
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).