mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
Windows: Clean up documentation (#36684)
This PR includes: - Further cleanup of BOTMETA.yml - Cleanup of author github handles - Use of proper booleans - One-line license statement - Copyright format statement - Smaller cleanups
This commit is contained in:
parent
4ab96722cf
commit
07e8fb5dbb
81 changed files with 751 additions and 1591 deletions
|
@ -1,22 +1,8 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
|
||||
#
|
||||
# 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 <http://www.gnu.org/licenses/>.
|
||||
# Copyright: (c) 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# this is a windows documentation stub. actual code lives in the .ps1
|
||||
# file of the same name
|
||||
|
@ -25,7 +11,6 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
'status': ['preview'],
|
||||
'supported_by': 'core'}
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: win_acl_inheritance
|
||||
|
@ -37,14 +22,11 @@ options:
|
|||
path:
|
||||
description:
|
||||
- Path to be used for changing inheritance
|
||||
required: true
|
||||
required: yes
|
||||
state:
|
||||
description:
|
||||
- Specify whether to enable I(present) or disable I(absent) ACL inheritance
|
||||
required: false
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
choices: [ absent, present ]
|
||||
default: absent
|
||||
reorganize:
|
||||
description:
|
||||
|
@ -52,12 +34,10 @@ options:
|
|||
(in combination with removal) for a simple ACL instead of using multiple ACE deny entries.
|
||||
- For P(state) = I(present), indicates if the inherited ACE's should be deduplicated compared to the parent directory. This removes complexity
|
||||
of the ACL structure.
|
||||
required: false
|
||||
choices:
|
||||
- no
|
||||
- yes
|
||||
default: no
|
||||
author: Hans-Joachim Kliemeck (@h0nIg)
|
||||
type: bool
|
||||
default: 'no'
|
||||
author:
|
||||
- Hans-Joachim Kliemeck (@h0nIg)
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
|
@ -70,13 +50,13 @@ EXAMPLES = r'''
|
|||
win_acl_inheritance:
|
||||
path: C:\apache
|
||||
state: absent
|
||||
reorganize: True
|
||||
reorganize: yes
|
||||
|
||||
- name: Enable and remove dedicated ACE's
|
||||
win_acl_inheritance:
|
||||
path: C:\apache
|
||||
state: present
|
||||
reorganize: True
|
||||
reorganize: yes
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue