diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2023-08-09 08:54:37 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2023-08-09 08:54:37 +0200 |
| commit | 2109dedc473944dbb38756cd48d0c44f996304c4 (patch) | |
| tree | 70544a43e6e403c7874cb250195346503edbe716 /libbuild2/functions-filesystem.cxx | |
| parent | d7b3619dad84f4f24aa3ab6629246a3324bdc2cd (diff) | |
Complete and cleanup function documentation in preparation for auto-extraction
Also:
- Move the $target.*() function family from functions-name.cxx to separate
functions-target.cxx.
- Get rid of the separate $process_path_ex.*() family, merging it with
$process_path.*().
Diffstat (limited to 'libbuild2/functions-filesystem.cxx')
| -rw-r--r-- | libbuild2/functions-filesystem.cxx | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/libbuild2/functions-filesystem.cxx b/libbuild2/functions-filesystem.cxx index 1acb3d1..665a0f3 100644 --- a/libbuild2/functions-filesystem.cxx +++ b/libbuild2/functions-filesystem.cxx @@ -103,14 +103,16 @@ namespace build2 function_family f (m, "filesystem"); - // $path_search(<pattern> [, <start-dir>]) + // $path_search(<pattern>[, <start-dir>]) // - // Return filesystem paths that match the pattern. If the pattern is an - // absolute path, then the start directory is ignored (if present). - // Otherwise, the start directory must be specified and be absolute. + // Return filesystem paths that match the shell-like wildcard pattern. If + // the pattern is an absolute path, then the start directory is ignored + // (if present). Otherwise, the start directory must be specified and be + // absolute. // // Note that this function is not pure. // + // @@ In the future we may want to add a flag that controls the // dangling/inaccessible treatment. // |