summaryrefslogtreecommitdiff
path: root/lib/ansible/plugins/filter/dirname.yml
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2023-03-29 17:53:19 -0400
committerGitHub <noreply@github.com>2023-03-29 14:53:19 -0700
commit6d64021d7bee839e98339c8a299ec17a3b49de75 (patch)
tree9bd01be5728527ab0e5e9d8a9dcb70ad3c15a567 /lib/ansible/plugins/filter/dirname.yml
parent08297ce0dbde9668841dc0949bf6445b75bea7f4 (diff)
downloadansible-6d64021d7bee839e98339c8a299ec17a3b49de75.tar.gz
Backportapalooza 03 29 (#80350)
* Update special_variables.rst (#80210) The usage of a glossary on this page will allow linking to a specific special variable, like on the glossary page, e.g.: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#term-Idempotency (cherry picked from commit 1491ec8019b064374145dace41b1320e04fb494b) * uri: improve force_basic_auth documentation (#80211) Add more details about what "true" and "false" mean for the force_basic_auth setting. Give example scenarios when clients may want to use this setting. (cherry picked from commit fc8203168e964b26478a0f28b0e34d9b34331fde) * Improve dirname and basename filter doc (#80054) (cherry picked from commit 93beef053eabdb6ff2a9823bc8d0d1037671b1e3) * Move Collection requirements to ansible/ansible (#80234) (cherry picked from commit cba395243454b0a959edea20425618fe7b9be775) * Add Ansible community 7.4.0 porting guide (#80338) (cherry picked from commit 29e0a68af251981b97b6c594e52051652ef472d3) * Add antsibull-changelog and antsibull-docs to other tools and programs page. (#80340) (cherry picked from commit cf44c84396ee2afdd0258aed1d09d5eecde94d17) --------- Co-authored-by: BenoƮt Geeraerts <10222438+b-enoit-be@users.noreply.github.com> Co-authored-by: Ken Dreyer <kdreyer@redhat.com> Co-authored-by: Daniel Ziegenberg <daniel@ziegenberg.at> Co-authored-by: Anwesha Das <anwesha@das.community> Co-authored-by: Felix Fontein <felix@fontein.de>
Diffstat (limited to 'lib/ansible/plugins/filter/dirname.yml')
-rw-r--r--lib/ansible/plugins/filter/dirname.yml4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/ansible/plugins/filter/dirname.yml b/lib/ansible/plugins/filter/dirname.yml
index 52f7d5d42e..4b8b0f7b29 100644
--- a/lib/ansible/plugins/filter/dirname.yml
+++ b/lib/ansible/plugins/filter/dirname.yml
@@ -5,6 +5,8 @@ DOCUMENTATION:
short_description: get a path's directory name
description:
- Returns the 'head' component of a path, basically everything that is not the 'basename'.
+ notes:
+ - The result of this filter is different from the Unix dirname program; where dirname for C(/foo/bar/) returns C(/foo), the dirname filter returns the full path (C(/foo/bar/)).
options:
_input:
description: A path.
@@ -15,7 +17,7 @@ DOCUMENTATION:
plugin_type: filter
EXAMPLES: |
- # To get the dir name of a file path, like '/etc/asdf' out of '/etc/asdf/foo.txt'
+ # To get the dir name of a file path, like '/etc/asdf' out of '/etc/asdf/foo.txt'.
{{ mypath | dirname }}
RETURN: