canonical-path: definition of ‘canonical’

[sanmai-NL]

Thanks for this crate!

What is your definition of canonical, per platform? Could this be written in the docs and API docs?

[tarcieri]

Hello, sorry for such a belated reply!

Indeed this is worth documenting, however the concrete definition is a tad tricky as canonicalization mechanisms tend to be rather complicated.

A brief definition: a canonical path contains no relative path components (i.e. ./..) or symbolic links.