openstack/neutron
Code Issues Proposed changes
4faac33168
neutron/neutron/objects/README.rst
Ankur Gupta 1762dc701b 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
2016-10-07 15:12:20 +00:00

618 B
Raw Blame History

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).