From: John Spray <john.spray@redhat.com>
Date: Tue, 19 Jun 2018 09:18:05 +0000 (+0100)
Subject: doc/mgr: note need for module.py file in plugins
X-Git-Tag: v14.0.1~1089^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F22622%2Fhead;p=ceph.git

doc/mgr: note need for module.py file in plugins

This is kind of a kludgy thing but let's at least
document it!

Signed-off-by: John Spray <john.spray@redhat.com>
---

diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst
index d2053e090d2..377078fd899 100644
--- a/doc/mgr/plugins.rst
+++ b/doc/mgr/plugins.rst
@@ -6,7 +6,8 @@ Creating a plugin
 -----------------
 
 In pybind/mgr/, create a python module.  Within your module, create a class
-that inherits from ``MgrModule``.
+that inherits from ``MgrModule``.  For ceph-mgr to detect your module, your
+directory must contain a file called `module.py`.
 
 The most important methods to override are: