Renamed sysmod module to sys while enforcing absolute imports.

This commit is contained in:
Pedro Algarvio 2013-08-19 17:53:14 +01:00
parent 758e789d12
commit 174a3e5b6c
5 changed files with 48 additions and 37 deletions

View File

@ -9,7 +9,7 @@ Full list of builtin execution modules
.. toctree::
salt.modules.pkg
salt.modules.sys
salt.modules.virtual-sys
.. currentmodule:: salt.modules
@ -154,7 +154,7 @@ Full list of builtin execution modules
supervisord
svn
sysbench
sysmod
sys
system
systemd
test
@ -198,3 +198,4 @@ Full list of builtin execution modules
salt.modules.gentoolkitmod
salt.modules.ldapmod
salt.modules.localemod
salt.modules.sysmod

View File

@ -2,32 +2,5 @@
salt.modules.sys
================
The regular salt modules execute in a separate context from the salt minion
and manipulating the actual salt modules needs to happen in a higher level
context within the minion process. This is where the sys pseudo module is
used.
The sys pseudo module comes with a few functions that return data about the
available functions on the minion or allows for the minion modules to be
refreshed. These functions are as follows:
.. py:module:: salt.modules.sys
.. py:function:: doc([module[, module.function]])
Display the inline documentation for all available modules, or for the
specified module or function.
.. py:function:: reload_modules
Instruct the minion to reload all available modules in memory. This
function can be called if the modules need to be re-evaluated for
availability or new modules have been made available to the minion.
.. py:function:: list_modules
List all available (loaded) modules.
.. py:function:: list_functions
List all known functions that are in available (loaded) modules.
.. automodule:: salt.modules.sys
:members:

View File

@ -1,6 +1,4 @@
===================
salt.modules.sysmod
===================
salt.modules.sysmod -> salt.modules.sys
---------------------------------------
.. automodule:: salt.modules.sysmod
:members:
Please see :doc:`salt.modules.sys`.

View File

@ -0,0 +1,38 @@
================
salt.modules.sys
================
The regular salt modules execute in a separate context from the salt minion
and manipulating the actual salt modules needs to happen in a higher level
context within the minion process. This is where the sys pseudo module is
used.
The sys pseudo module comes with a few functions that return data about the
available functions on the minion or allows for the minion modules to be
refreshed. These functions are as follows:
.. py:module:: salt.modules.sys
:noindex:
.. py:function:: doc([module[, module.function]])
:noindex:
Display the inline documentation for all available modules, or for the
specified module or function.
.. py:function:: reload_modules
:noindex:
Instruct the minion to reload all available modules in memory. This
function can be called if the modules need to be re-evaluated for
availability or new modules have been made available to the minion.
.. py:function:: list_modules
:noindex:
List all available (loaded) modules.
.. py:function:: list_functions
:noindex:
List all known functions that are in available (loaded) modules.

View File

@ -4,6 +4,7 @@ minion.
'''
# Import python libs
from __future__ import absolute_import
import logging
# Import salt libs
@ -16,7 +17,7 @@ def __virtual__():
'''
Return as sys
'''
return 'sys'
return True
def doc(*args, **kwargs):