From 9f6ec548ab5608a95de310fcffd08776a2cb3a8e Mon Sep 17 00:00:00 2001
From: Simon McVittie <smcv@collabora.com>
Date: Tue, 27 Jul 2021 11:46:33 +0100
Subject: [PATCH] utils: Document that flatpak_canonicalize_filename() does not
 do I/O

Signed-off-by: Simon McVittie <smcv@collabora.com>
---
 common/flatpak-utils-base.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/common/flatpak-utils-base.c b/common/flatpak-utils-base.c
index ac636071..4be6fae7 100644
--- a/common/flatpak-utils-base.c
+++ b/common/flatpak-utils-base.c
@@ -100,6 +100,12 @@ flatpak_resolve_link (const char *path,
   return g_build_filename (dirname, link, NULL);
 }
 
+/*
+ * Syntactically canonicalize a filename, similar to
+ * g_canonicalize_filename() in newer GLib.
+ *
+ * This function does not do I/O.
+ */
 char *
 flatpak_canonicalize_filename (const char *path)
 {