internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-08 06:12:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[PR #11997/240ff653 backport][stable-11] filetree lookup: document RETURN value state (#12009)

Browse Source 
filetree lookup: document RETURN value `state` (#11997)

* Clarify 'state' parameter description in filetree.py

Updated the description for the 'state' parameter to clarify entry types and their meanings.

* Apply suggestion from felixfontein related to description



---------


(cherry picked from commit 240ff65311)

Co-authored-by: Santosh Mahale <santoshmahale7676@gmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot]
2026-05-07 21:58:51 +02:00
committed by GitHub
parent 6eb8ccd1ea
commit 558b2bfd76
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
plugins/lookup/filetree.py
View File

@@ -80,8 +80,12 @@ _raw:
description: The permissions the resulting file or directory. description: The permissions the resulting file or directory.
type: str type: str
state: state:
description: TODO. description:
- Type of the resulting file or directory.
- V(directory) for a directory, V(file) for a regular file, V(link) for a symbolic link.
- Other file types are skipped and not returned.
type: str type: str
choices: [directory, file, link]
owner: owner:
description: Name of the user that owns the file/directory. description: Name of the user that owns the file/directory.
type: raw type: raw