From 92534855cc11e0939f769e19d995be0605be2fb2 Mon Sep 17 00:00:00 2001 From: "Michael Hirsch, Ph.D" Date: Wed, 18 Dec 2019 22:53:47 -0500 Subject: doc: filesystem module --- docs/markdown/Fs-module.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'docs/markdown') diff --git a/docs/markdown/Fs-module.md b/docs/markdown/Fs-module.md index 3b33e7f..64883c0 100644 --- a/docs/markdown/Fs-module.md +++ b/docs/markdown/Fs-module.md @@ -9,8 +9,13 @@ Non-absolute paths are looked up relative to the directory where the current `meson.build` file is. If specified, a leading `~` is expanded to the user home directory. +Environment variables are not available as is the rule throughout Meson. +That is, $HOME, %USERPROFILE%, $MKLROOT, etc. have no meaning to the Meson +filesystem module. If needed, pass such variables into Meson via command +line options in `meson_options.txt`, native-file or cross-file. -Where possible, symlinks and parent directory notation are resolved to an absolute path. +Where possible, symlinks and parent directory notation are resolved to an +absolute path. ### exists @@ -42,7 +47,7 @@ Return a boolean indicating if the path string specified is absolute, WITHOUT ex Examples: ```meson -fs.is_absolute('~') # false unless you literally have a path with string name `~` +fs.is_absolute('~') # false home = fs.expanduser('~') fs.is_absolute(home) # true @@ -84,7 +89,7 @@ fs.is_samepath(x, z) # true fs.is_samepath(x, j) # false p = 'foo/bar' -q = 'foo/bar/../baz' +q = 'foo/bar/baz/..' r = 'buz' # a symlink pointing to foo/bar s = 'notapath' # non-existant directory @@ -93,7 +98,6 @@ fs.is_samepath(p, r) # true fs.is_samepath(p, s) # false ``` - ## Filename modification The files need not actually exist yet for these path string manipulation methods. -- cgit v1.1