doc

CMakeLists.txt

@@ -7,7 +7,7 @@ endif()
 
 project(ffilesystem
 LANGUAGES C
-VERSION 5.7.2
+VERSION 5.8.0
 )
 
 if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.30.0 AND CMAKE_VERSION VERSION_LESS 3.30.4)

fpm.toml

@@ -1,7 +1,7 @@
 name = "ffilesystem"
 description = "Lightweight filesystem and path manipulations"
 categories = "io"
-version = "5.7.2"
+version = "5.8.0"
 
 [build]
 auto-examples = false

meson.build

@@ -1,5 +1,5 @@
 project('ffilesystem', ['c'],
-version: '5.7.2',
+version: '5.8.0',
 default_options: ['c_std=c99', 'cpp_std=c++23,c++20,c++17', 'buildtype=release', 'b_ndebug=if-release'],
 meson_version : '>=1.4.0')
 

src/c/resolve.c

@@ -24,9 +24,7 @@
 size_t fs_canonical(const char* path, const bool strict, const bool expand_tilde,
                     char* result, const size_t buffer_size)
 {
-  // distinct from resolve()
-
-  // distinct from resolve
+  // canonicalize path, i.e. resolve all symbolic links, remove ".", ".." and extra slashes
   const size_t L = strlen(path);
   if(L == 0)
     return 0;
@@ -85,6 +83,7 @@ bool fs_equivalent(const char* path1, const char* path2)
 size_t fs_absolute(const char* path, const char* base, const bool expand_tilde,
                         char* result, const size_t buffer_size)
 {
+  // works mostly like Python pathlib.Path.absolute()
 
   char* ex = (char*) malloc(buffer_size);
   if(!ex) return 0;

src/common/resolve.cpp

@@ -40,6 +40,7 @@ std::optional<std::string> Ffs::canonical(std::string_view path, const bool stri
 std::string Ffs::absolute(std::string_view path, const bool expand_tilde)
 {
   // wraps std::filesystem::absolute(path).
+  // path need not exist
   // Inspired by Python pathlib.Path.absolute()
   // https://docs.python.org/3/library/pathlib.html#pathlib.Path.absolute
 
@@ -66,6 +67,7 @@ std::string Ffs::absolute(std::string_view path, const bool expand_tilde)
 
 std::string Ffs::absolute(std::string_view path, std::string_view base, const bool expand_tilde)
 {
+  // variant that allow rebasing on base path
   const auto ex = expand_tilde
     ? std::filesystem::path(Ffs::expanduser(path))
     : path;