mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 13:22:48 +00:00
DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string Added deprecation warning to moduledev.rst and remove deprecated example from it Fixed up a few typos and uppercased some acronyms. add consistency to how EXAMPLES are formatted
This commit is contained in:
@@ -50,9 +50,11 @@ options:
|
||||
description:
|
||||
- If C(yes), any modified files in the working
|
||||
tree will be discarded.
|
||||
examples:
|
||||
- code: "bzr name=bzr+ssh://foosball.example.org/path/to/branch dest=/srv/checkout version=22"
|
||||
description: Example bzr checkout from Ansible Playbooks
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Example bzr checkout from Ansible Playbooks
|
||||
- bzr: name=bzr+ssh://foosball.example.org/path/to/branch dest=/srv/checkout version=22
|
||||
'''
|
||||
|
||||
import re
|
||||
|
||||
@@ -73,13 +73,19 @@ options:
|
||||
- If C(yes), repository will be updated using the supplied
|
||||
remote. Otherwise the repo will be left untouched.
|
||||
Prior to 1.2, this was always 'yes' and could not be disabled.
|
||||
examples:
|
||||
- code: "git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22"
|
||||
description: Example git checkout from Ansible Playbooks
|
||||
- code: "git: repo=ssh://git@github.com/mylogin/hello.git dest=/home/mylogin/hello"
|
||||
description: Example read-write git checkout from github
|
||||
- code: "git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout update=no"
|
||||
description: Example just ensuring the repo checkout exists
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Example git checkout from Ansible Playbooks
|
||||
- git: repo=git://foosball.example.org/path/to/repo.git
|
||||
dest=/srv/checkout
|
||||
version=release-0.22
|
||||
|
||||
# Example read-write git checkout from github
|
||||
- git: repo=ssh://git@github.com/mylogin/hello.git dest=/home/mylogin/hello
|
||||
|
||||
# Example just ensuring the repo checkout exists
|
||||
- git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout update=no
|
||||
'''
|
||||
|
||||
import re
|
||||
|
||||
@@ -72,13 +72,15 @@ notes:
|
||||
C(StrictHostKeyChecking no) in C(.ssh/config) which will accept and authorize the connection
|
||||
on behalf of the user. However, if you run as a different user such as setting sudo to True),
|
||||
for example, root will not look at the user .ssh/config setting.
|
||||
examples:
|
||||
- code: "hg: repo=https://bitbucket.org/user/repo1 dest=/home/user/repo1 revision=stable purge=yes"
|
||||
description: Ensure the current working copy is inside the stable branch and deletes untracked files if any.
|
||||
|
||||
requirements: [ ]
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Ensure the current working copy is inside the stable branch and deletes untracked files if any.
|
||||
- hg: repo=https://bitbucket.org/user/repo1 dest=/home/user/repo1 revision=stable purge=yes
|
||||
'''
|
||||
|
||||
def _set_hgrc(hgrc, vals):
|
||||
parser = ConfigParser.SafeConfigParser()
|
||||
parser.read(hgrc)
|
||||
|
||||
@@ -61,9 +61,11 @@ options:
|
||||
- --password parameter passed to svn.
|
||||
required: false
|
||||
default: null
|
||||
examples:
|
||||
- code: "subversion: repo=svn+ssh://an.example.org/path/to/repo dest=/src/checkout"
|
||||
description: Checkout subversion repository to specified folder.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Checkout subversion repository to specified folder.
|
||||
- subversion: repo=svn+ssh://an.example.org/path/to/repo dest=/src/checkout
|
||||
'''
|
||||
|
||||
import re
|
||||
|
||||
Reference in New Issue
Block a user