From e463f94ce9e817838ccdce2b966435c21fba5faf Mon Sep 17 00:00:00 2001
From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com>
Date: Sat, 12 Aug 2023 19:35:47 +0200
Subject: [PATCH] [PR #7010/7496466f backport][stable-6] Update chroot.py -
 better documentation (#7100)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Update chroot.py - better documentation (#7010)

* Update chroot.py

Better informations about sudo and env.

* Update plugins/connection/chroot.py

---------

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 7496466f9d2c5709618bc856f00a3b8eb74387de)

Co-authored-by: Przemysław Sztoch <psztoch@finn.pl>
---
 plugins/connection/chroot.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/plugins/connection/chroot.py b/plugins/connection/chroot.py
index 0b171c118b..7903ab7046 100644
--- a/plugins/connection/chroot.py
+++ b/plugins/connection/chroot.py
@@ -49,8 +49,10 @@ DOCUMENTATION = '''
 '''
 
 EXAMPLES = r"""
-# Static inventory file
+# Plugin requires root privileges for chroot, -E preserves your env (and location of ~/.ansible):
+# sudo -E ansible-playbook ...
 #
+# Static inventory file
 # [chroots]
 # /path/to/debootstrap
 # /path/to/feboostrap