[node-patches] Change in ovirt-node[master]: utils: Improve documentation

[fabiand at fedoraproject.org]

Fabian Deutsch has uploaded a new change for review.

Change subject: utils: Improve documentation
......................................................................

utils: Improve documentation

Change-Id: Ib8436eba968977ff1e63a36d58693fd68af1e487
Signed-off-by: Fabian Deutsch <fabiand at fedoraproject.org>
---
M src/ovirt/node/utils/__init__.py
1 file changed, 9 insertions(+), 1 deletion(-)


  git pull ssh://gerrit.ovirt.org:29418/ovirt-node refs/changes/01/27601/1

diff --git a/src/ovirt/node/utils/__init__.py b/src/ovirt/node/utils/__init__.py
index 8c49c31..f1a00fe 100644
--- a/src/ovirt/node/utils/__init__.py
+++ b/src/ovirt/node/utils/__init__.py
@@ -29,7 +29,15 @@
 It is aimed that the modules in trhis package display live informations and not
 informations based on static config files.
 Use the .config package for stuff related to configuration files.
-And use the model.py module for oVirt Node's defaults file.
+And use the config/defaults.py module for oVirt Node's defaults file.
+
+The modules in this package should generally not know about the special nature
+of Node. That means that there should be no logic in this package related to
+special properties of Node.
+I.e. should the persistence handling be done in the config.defaults module.
+That way we concentrate the Node specific logic in the defaults.config module.
+And this package contains reliable functions to common operating system tasks.
+
 """
 
 


-- 
To view, visit http://gerrit.ovirt.org/27601
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib8436eba968977ff1e63a36d58693fd68af1e487
Gerrit-PatchSet: 1
Gerrit-Project: ovirt-node
Gerrit-Branch: master
Gerrit-Owner: Fabian Deutsch <fabiand at fedoraproject.org>