Skip to content

Commit

Permalink
[WasmFS] Remove stale comments in WasmFS code: it is stable now (emsc…
Browse files Browse the repository at this point in the history
…ripten-core#23263)

These "in progress" comments could be misleading, since the code
has been stable for quite some time.
  • Loading branch information
kripken authored Jan 2, 2025
1 parent 89c42b2 commit c3d1937
Show file tree
Hide file tree
Showing 17 changed files with 23 additions and 51 deletions.
2 changes: 1 addition & 1 deletion site/source/docs/api_reference/Filesystem-API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ A high level overview of the way File Systems work in Emscripten-ported code is
New File System: WasmFS
=======================

.. note:: Current Status: Work in Progress
.. note:: Current Status: Stable, but not yet feature-complete with the old FS.

WasmFS is a high-performance, fully-multithreaded, WebAssembly-based file system layer for Emscripten that will replace the existing JavaScript version.

Expand Down
3 changes: 0 additions & 3 deletions system/lib/wasmfs/backend.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
// found in the LICENSE file.

// This file defines the modular backend abstract class.
// Other file system backends can use this to interface with the new file
// system. Current Status: Work in Progress. See
// /~https://github.com/emscripten-core/emscripten/issues/15041.

#pragma once

Expand Down
3 changes: 1 addition & 2 deletions system/lib/wasmfs/backends/fetch_backend.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines the JS file backend and JS file of the new file system.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.
// This file defines the fetch backend.

#include "fetch_backend.h"
#include "backend.h"
Expand Down
3 changes: 1 addition & 2 deletions system/lib/wasmfs/backends/js_file_backend.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines the JS file backend and JS file of the new file system.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.
// This file defines the JS file backend.

#include "js_file_backend.h"
#include "backend.h"
Expand Down
4 changes: 1 addition & 3 deletions system/lib/wasmfs/backends/memory_backend.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines the memory file backend of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.
// This file defines the memory file backend.

#include "memory_backend.h"
#include "backend.h"
Expand Down
5 changes: 2 additions & 3 deletions system/lib/wasmfs/file.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.
// This file defines the file object of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

// This file defines the file object.

#include "file.h"
#include "wasmfs.h"
Expand Down
4 changes: 1 addition & 3 deletions system/lib/wasmfs/file.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines the file object of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.
// This file defines the file object.

#pragma once

Expand Down
5 changes: 2 additions & 3 deletions system/lib/wasmfs/file_table.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.
// This file defines the open file table of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

// This file defines the open file table.

#include "file_table.h"
#include "special_files.h"
Expand Down
5 changes: 2 additions & 3 deletions system/lib/wasmfs/file_table.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.
// This file defines the open file table of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

// This file defines the open file table.

#pragma once

Expand Down
6 changes: 2 additions & 4 deletions system/lib/wasmfs/fuzzer/fuzzer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines a fuzzer that will validate operations in the new file
// system in a multi-threaded setting.
// Current Status: Work in Progress. See
// /~https://github.com/emscripten-core/emscripten/issues/15041.
// This file defines a fuzzer that validates operations in a multi-threaded
// setting.

#include "parameters.h"
#include "random.h"
Expand Down
4 changes: 0 additions & 4 deletions system/lib/wasmfs/js_impl_backend.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines the JS file backend and JS file of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

#pragma once

#include "backend.h"
Expand Down
6 changes: 2 additions & 4 deletions system/lib/wasmfs/memory_backend.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines the memory file class of the new file system.
// This should be the only backend file type defined in a header since it is the
// default type. Current Status: Work in Progress. See
// /~https://github.com/emscripten-core/emscripten/issues/15041.
// This file defines the memory file class. This should be the only backend file
// type defined in a header since it is the default type.

#pragma once

Expand Down
4 changes: 0 additions & 4 deletions system/lib/wasmfs/proxied_async_js_impl_backend.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.

// This file defines the JS file backend and JS file of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

#pragma once

#include "backend.h"
Expand Down
5 changes: 2 additions & 3 deletions system/lib/wasmfs/special_files.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.
// This file defines the standard streams of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

// This file defines the standard streams.

#include <emscripten/html5.h>
#include <unistd.h>
Expand Down
5 changes: 2 additions & 3 deletions system/lib/wasmfs/syscalls.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.
// syscalls.cpp will implement the syscalls of the new file system replacing the
// old JS version. Current Status: Work in Progress. See
// /~https://github.com/emscripten-core/emscripten/issues/15041.

// Syscall implementations.

#define _LARGEFILE64_SOURCE // For F_GETLK64 etc

Expand Down
5 changes: 2 additions & 3 deletions system/lib/wasmfs/wasmfs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.
// This file defines the global state of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

// This file defines the global state.

#include <emscripten/threading.h>

Expand Down
5 changes: 2 additions & 3 deletions system/lib/wasmfs/wasmfs.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License. Both these licenses can be
// found in the LICENSE file.
// This file defines the global state of the new file system.
// Current Status: Work in Progress.
// See /~https://github.com/emscripten-core/emscripten/issues/15041.

// This file defines the global state.

#pragma once

Expand Down

0 comments on commit c3d1937

Please sign in to comment.