From 1762dc701b8e8c54d4a9189b1211515643d9f844 Mon Sep 17 00:00:00 2001 From: Ankur Gupta Date: Mon, 8 Aug 2016 14:46:09 -0500 Subject: [PATCH] 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 --- neutron/objects/README.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 neutron/objects/README.rst diff --git a/neutron/objects/README.rst b/neutron/objects/README.rst new file mode 100644 index 00000000000..9a2cf309db5 --- /dev/null +++ b/neutron/objects/README.rst @@ -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). +