add comment about os.fsdecode()

pypa · Dec 4, 2021 · aadee0d · aadee0d
1 parent f845c61
commit aadee0d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/flit/vcs/git.py b/flit/vcs/git.py
@@ -7,6 +7,8 @@
 def list_tracked_files(directory):
     outb = check_output(['git', 'ls-files', '--recurse-submodules', '-z'],
                         cwd=str(directory))
+    # NOTE: os.fsdecode() may cause issues if git returns path names that
+    # aren't in the filesystem encoding
     return [osp.normpath(os.fsdecode(l)) for l in outb.strip(b'\0').split(b'\0') if l]
 
 def list_untracked_deleted_files(directory):