Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

archive docs formatting #21454

Merged
merged 1 commit into from
Feb 15, 2017
Merged

archive docs formatting #21454

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions lib/ansible/modules/files/archive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@
short_description: Creates a compressed archive of one or more files or trees.
extends_documentation_fragment: files
description:
- The C(archive) module packs an archive. It is the opposite of the unarchive module. By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying C(remove)=I(True).
- Packs an archive. It is the opposite of M(unarchive). By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying I(remove=True).
options:
path:
description:
- Remote absolute path, glob, or list of paths or globs for the file or files to compress or archive.
required: true
format:
description:
- The type of compression to use. Can be 'gz', 'bz2', or 'zip'.
- The type of compression to use.
choices: [ 'gz', 'bz2', 'zip' ]
default: 'gz'
dest:
Expand All @@ -49,7 +49,6 @@
remove:
description:
- Remove any added source files and trees after adding to archive.
type: bool
required: false
default: false

Expand Down