Skip to content

Commit 5f5efe1

Browse files
committed
Add note about supervisor filesystem APIs
1 parent 150230d commit 5f5efe1

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

‎supervisor/filesystem.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ extern volatile bool filesystem_flush_requested;
3434

3535
// Supervisor-level filesystem API. These functions work on both FAT and
3636
// littlefs mounts so that supervisor code (workflows, settings) doesn't have to
37-
// care which one is active.
37+
// care which one is active. These APIs do not raise Python exceptions or use VM
38+
// heap allocated memory so they are safe use when the Python VM isn't active.
3839

3940
// Open flags for supervisor_vfs_open_file().
4041
#define SUPERVISOR_FS_OPEN_READ 0x01

0 commit comments

Comments
 (0)