Docs updates to add examples for symbolic modes

Also fixes missing doc fragments missing in template and assemble
pull/7920/merge
James Cammarata 10 years ago
parent 811ff49f78
commit d1d3394046

@ -79,11 +79,8 @@ options:
U(http://docs.python.org/2/library/re.html). U(http://docs.python.org/2/library/re.html).
required: false required: false
default: null default: null
others:
description:
- all arguments accepted by the M(file) module also work here
required: false
author: Stephen Fromm author: Stephen Fromm
extends_documentation_fragment: files
''' '''
EXAMPLES = ''' EXAMPLES = '''

@ -95,6 +95,12 @@ EXAMPLES = '''
# Example from Ansible Playbooks # Example from Ansible Playbooks
- copy: src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644 - copy: src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644
# The same example as above, but using a symbolic mode equivalent to 0644
- copy: src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode="u=rw,g=r,o=r"
# Another symbolic mode example, adding some permissions and removing others
- copy: src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode="u+rw,g-wx,o-rwx"
# Copy a new "ntp.conf file into place, backing up the original if it differs from the copied version # Copy a new "ntp.conf file into place, backing up the original if it differs from the copied version
- copy: src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes - copy: src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes

@ -94,6 +94,13 @@ EXAMPLES = '''
with_items: with_items:
- { path: 'x', dest: 'y' } - { path: 'x', dest: 'y' }
- { path: 'z', dest: 'k' } - { path: 'z', dest: 'k' }
# touch a file, using symbolic modes to set the permissions (equivalent to 0644)
- file: path=/etc/foo.conf state=touch mode="u=rw,g=r,o=r"
# touch the same file, but add/remove some permissions
- file: path=/etc/foo.conf state=touch mode="u+rw,g-wx,o-rwx"
''' '''
def main(): def main():

@ -51,12 +51,16 @@ notes:
- "Since Ansible version 0.9, templates are loaded with C(trim_blocks=True)." - "Since Ansible version 0.9, templates are loaded with C(trim_blocks=True)."
requirements: [] requirements: []
author: Michael DeHaan author: Michael DeHaan
extends_documentation_fragment: files
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Example from Ansible Playbooks # Example from Ansible Playbooks
- template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644 - template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
# The same example, but using symbolic modes equivalent to 0644
- template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode="u=rw,g=r,o=r"
# Copy a new "sudoers" file into place, after passing validation with visudo # Copy a new "sudoers" file into place, after passing validation with visudo
- template: src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s' - template: src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'
''' '''

Loading…
Cancel
Save