chiark / gitweb /
tests: clarify test_path_startswith return value (#4508)
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sun, 30 Oct 2016 14:21:29 +0000 (10:21 -0400)
committerSven Eden <yamakuzure@gmx.net>
Wed, 5 Jul 2017 06:50:56 +0000 (08:50 +0200)
A pendant for #4481.

src/basic/path-util.c

index cdbb2d3..3af95bf 100644 (file)
@@ -356,6 +356,16 @@ char* path_startswith(const char *path, const char *prefix) {
         assert(path);
         assert(prefix);
 
         assert(path);
         assert(prefix);
 
+        /* Returns a pointer to the start of the first component after the parts matched by
+         * the prefix, iff
+         * - both paths are absolute or both paths are relative,
+         * and
+         * - each component in prefix in turn matches a component in path at the same position.
+         * An empty string will be returned when the prefix and path are equivalent.
+         *
+         * Returns NULL otherwise.
+         */
+
         if ((path[0] == '/') != (prefix[0] == '/'))
                 return NULL;
 
         if ((path[0] == '/') != (prefix[0] == '/'))
                 return NULL;