summaryrefslogtreecommitdiff
path: root/libs/pbd/pbd/filesystem.h
diff options
context:
space:
mode:
authorTim Mayberry <mojofunk@gmail.com>2012-06-23 05:08:01 +0000
committerTim Mayberry <mojofunk@gmail.com>2012-06-23 05:08:01 +0000
commit1d3594cc9b480914103eba1a81d2b3f93920c060 (patch)
tree8a870a8ad18a1d4108df156ff7f1fd85c14c30a8 /libs/pbd/pbd/filesystem.h
parent17475df100de18b01dee4c0d943fa2c26405bf4e (diff)
Add docs for PBD::sys::equivalent_paths
git-svn-id: svn://localhost/ardour2/branches/3.0@12858 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'libs/pbd/pbd/filesystem.h')
-rw-r--r--libs/pbd/pbd/filesystem.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/libs/pbd/pbd/filesystem.h b/libs/pbd/pbd/filesystem.h
index c347f3cc42..68fa310930 100644
--- a/libs/pbd/pbd/filesystem.h
+++ b/libs/pbd/pbd/filesystem.h
@@ -192,7 +192,14 @@ path get_absolute_path (const path &);
bool path_is_within (const path &, path);
-bool equivalent_paths (const std::string &, const std::string &);
+/**
+ * @return true if p1 and p2 both resolve to the same file
+ * @param p1 a file path.
+ * @param p2 a file path.
+ *
+ * Uses g_stat to check for identical st_dev and st_ino values.
+ */
+bool equivalent_paths (const std::string &p1, const std::string &p2);
} // namespace sys