diff --git a/lib/ansible/utils/module_docs_fragments/backup.py b/lib/ansible/utils/module_docs_fragments/backup.py new file mode 100644 index 0000000000..bee7182a91 --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/backup.py @@ -0,0 +1,30 @@ +# Copyright (c) 2015 Ansible, Inc +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + + +class ModuleDocFragment(object): + + # Standard documentation fragment + DOCUMENTATION = ''' + backup: + description: + - Create a backup file including the timestamp information so you can get + the original file back if you somehow clobbered it incorrectly. + required: false + choices: [ "yes", "no" ] + default: "no" +''' diff --git a/lib/ansible/utils/module_docs_fragments/validate.py b/lib/ansible/utils/module_docs_fragments/validate.py new file mode 100644 index 0000000000..6b4a14b7fa --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/validate.py @@ -0,0 +1,30 @@ +# Copyright (c) 2015 Ansible, Inc +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + + +class ModuleDocFragment(object): + + # Standard documentation fragment + DOCUMENTATION = ''' + validate: + required: false + description: + - The validation command to run before copying into place. The path to the file to + validate is passed in via '%s' which must be present as in the apache example below. + The command is passed securely so shell features like expansion and pipes won't work. + default: None +'''