diff options
| author | Charles Ferguson <gerph@gerph.org> | 2015-11-27 20:49:27 +0000 |
|---|---|---|
| committer | Charles Ferguson <gerph@gerph.org> | 2015-11-27 20:49:27 +0000 |
| commit | 176b4103b60698a9327bb388d217200d7bbc4818 (patch) | |
| tree | 02364e358ee69baadc83a2bff26e3739916b367b | |
| parent | 9325c0ae5fde9bb035e7f03017b8ce8bcdd635a5 (diff) | |
| download | ansible-modules-core-176b4103b60698a9327bb388d217200d7bbc4818.tar.gz | |
Add documentation to 'file' AnsibleModule definition for internals.
The parameters 'diff_peek' and 'validate' are not expected to be used
by users. They are internal. To make it clear, this change adds the
comments 'Internal use only' to each of those definitions to make
it clear that they are actually used, just not by end-users.
| -rw-r--r-- | files/file.py | 9 |
1 files changed, 2 insertions, 7 deletions
diff --git a/files/file.py b/files/file.py index 9e79d4ac..cc94922f 100644 --- a/files/file.py +++ b/files/file.py @@ -87,12 +87,6 @@ options: - 'force the creation of the symlinks in two cases: the source file does not exist (but will appear later); the destination exists and is a file (so, we need to unlink the "path" file and create symlink to the "src" file in place of it).' - diff_peek: - required: false - description: - - "Only check whether the file looks like binary. Returns with the parameter - 'appears_binary' set to True or False depending on the initial content of the - file. This option is enabled when the option is set (to any value)." ''' EXAMPLES = ''' @@ -163,7 +157,8 @@ def main(): original_basename = dict(required=False), # Internal use only, for recursive ops recurse = dict(default=False, type='bool'), force = dict(required=False, default=False, type='bool'), - diff_peek = dict(default=None), + diff_peek = dict(default=None), # Internal use only, for internal checks in the action plugins + validate = dict(required=False, default=None), # Internal use only, for template and copy src = dict(required=False, default=None), ), add_file_common_args=True, |