From: Yu Watanabe Date: Sun, 18 Sep 2022 14:19:13 +0000 (+0900) Subject: path-util: add examples for path_make_relative() and path_make_relative_parent() X-Git-Tag: v252-rc1~151 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=28f9bcd65a31487c9d624ded723fc7cd07af69c7;p=thirdparty%2Fsystemd.git path-util: add examples for path_make_relative() and path_make_relative_parent() Addresses https://github.com/systemd/systemd/pull/24646#discussion_r973691797. --- diff --git a/src/basic/path-util.c b/src/basic/path-util.c index 29a899b421d..d8167da4f84 100644 --- a/src/basic/path-util.c +++ b/src/basic/path-util.c @@ -202,7 +202,17 @@ int path_make_relative_parent(const char *from_child, const char *to, char **ret assert(ret); /* Similar to path_make_relative(), but provides the relative path from the parent directory of - * 'from_child'. This may be useful when creating relative symlink. */ + * 'from_child'. This may be useful when creating relative symlink. + * + * E.g. + * - from = "/path/to/aaa", to = "/path/to/bbb" + * path_make_relative(from, to) = "../bbb" + * path_make_relative_parent(from, to) = "bbb" + * + * - from = "/path/to/aaa/bbb", to = "/path/to/ccc/ddd" + * path_make_relative(from, to) = "../../ccc/ddd" + * path_make_relative_parent(from, to) = "../ccc/ddd" + */ r = path_extract_directory(from_child, &from); if (r < 0)