From a023f2a344aae28d4441e0f6923b8144fe65c1ac Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 21 Oct 2022 07:08:39 +0200 Subject: [PATCH] archive: better expose requirements (#5392) * Better expose requirements. * Move sentence back to notes. * Update plugins/modules/files/archive.py Co-authored-by: Maxwell G * Break line. Co-authored-by: Maxwell G --- plugins/modules/files/archive.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/plugins/modules/files/archive.py b/plugins/modules/files/archive.py index 36e00487c7..83eae34f56 100644 --- a/plugins/modules/files/archive.py +++ b/plugins/modules/files/archive.py @@ -66,13 +66,15 @@ options: type: bool default: false notes: - - Requires tarfile, zipfile, gzip and bzip2 packages on target host. - - Requires lzma or backports.lzma if using xz format. - - Can produce I(gzip), I(bzip2), I(lzma) and I(zip) compressed files or archives. + - Can produce I(gzip), I(bzip2), I(lzma), and I(zip) compressed files or archives. + - This module uses C(tarfile), C(zipfile), C(gzip), and C(bz2) packages on the target host to create archives. + These are part of the Python standard library for Python 2 and 3. +requirements: + - Requires C(lzma) (standard library of Python 3) or L(backports.lzma, https://pypi.org/project/backports.lzma/) (Python 2) if using C(xz) format. seealso: -- module: ansible.builtin.unarchive + - module: ansible.builtin.unarchive author: -- Ben Doherty (@bendoh) + - Ben Doherty (@bendoh) ''' EXAMPLES = r'''