paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-10-03 07:20:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazUtils/lazfileutils. Updates the ResolveDots topic for changes in 148b2d23. Issue #40678.

Browse Source
This commit is contained in:
dsiders 2024-01-13 16:59:55 +00:00
parent 92271f5b1a
commit 5f19d0caf8
1 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/xml/lazutils/lazfileutils.xml
View File

@ -1029,26 +1029,49 @@ Windows-specific file system quirks handled in the routine include:
<dd>Resolved to C:\</dd> <dd>Resolved to C:\</dd>
<dt>\\..</dt> <dt>\\..</dt>
<dd>Resolved to \\</dd> <dd>Resolved to \\</dd>
<dt>c:/path/to/dir</dt>
<dd>
Resolved to C:\path\to\dir using the PathDelimiter for the platform.
</dd>
</dl> </dl>
<p> <p>
For UNIX-like environments, the resolved path may be invalid if it references For UNIX-like environments, the resolved path may be invalid if it references
the parent directory and the initial directory in the path is a symbolic link. the parent directory and the initial directory in the path is a symbolic link.
</p> </p>
<p> <p>
When AFilename ends with a relative path ('/.' or '/..'), an additional path When AFilename ends with a relative path ('/.' or '/..'), the path is resolved
delimiter is added to the return value. to the directory represented by the relative value. The current directory for
'/.' or the parent directory for '/..'.
</p> </p>
<p> <p>
If a relative path reference cannot be resolved for the local file system, If a relative path reference cannot be resolved for the local file system,
the original path information is retained. the original path information is retained.
</p> </p>
<p> <p>
Macros found in the AFilename are retained if the relative path references a Some common examples include:
parent directory. For example: </p>
<dl>
<dt>foo/bar/..</dt>
<dd>Resolved to foo</dd>
<dt>foo//..//</dt>
<dd>Resolved to .</dd>
<dt>foo/bar/./../baz</dt>
<dd>Resolved to foo/baz</dd>
<dt>/a/b/../..</dt>
<dd>Resolved to /</dd>
<dt>.//.//.</dt>
<dd>Resolved to .</dd>
</dl>
<p>
Macros found in the AFilename are retained in the resolved file name. For example:
</p> </p>
<code> <code>
'($LazarusDir)/../path/that/may/be/invalid/for/macro/filename.ext' '($LazarusDir)/../path/that/may/be/invalid/for/macro/filename.ext'
</code> </code>
<p>
If AFilename ends with a path trailing path delimiter or a relative path
reference, the return value will end with a trailing path delimiter.
</p>
</descr> </descr>
</element> </element>
<element name="ResolveDots.Result"> <element name="ResolveDots.Result">