summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/relpath.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/filter/relpath.yml')
-rw-r--r--lib/ansible/plugins/filter/relpath.yml28
1 files changed, 28 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/relpath.yml b/lib/ansible/plugins/filter/relpath.yml
new file mode 100644
index 0000000..47611c7
--- /dev/null
+++ b/lib/ansible/plugins/filter/relpath.yml
@@ -0,0 +1,28 @@
+DOCUMENTATION:
+ name: relpath
+ author: Jakub Jirutka (@jirutka)
+ version_added: "1.7"
+ short_description: Make a path relative
+ positional: _input, start
+ description:
+ - Converts the given path to a relative path from the I(start),
+ or relative to the directory given in I(start).
+ options:
+ _input:
+ description: A path.
+ type: str
+ required: true
+ start:
+ description: The directory the path should be relative to. If not supplied the current working directory will be used.
+ type: str
+
+EXAMPLES: |
+
+ # foobar => ../test/me.txt
+ testing: "{{ '/tmp/test/me.txt' | relpath('/tmp/other/') }}"
+ otherrelpath: "{{ mypath | relpath(mydir) }}"
+
+RETURN:
+ _value:
+ description: The relative path.
+ type: str