Skip to content

Commit eca6dc9

Browse files
author
Pat Hickey
committed
update phases/README to rename unstable to snapshot
Per #138 and discussion on 07nov19 wasi video call. Updates the steps for PR based on what I did for this first snapshot.
1 parent 3dffd94 commit eca6dc9

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

phases/README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,25 @@
88
provides no API stability or versioning. APIs in this directory use
99
API module names starting with `wasi_ephemeral_`.
1010

11-
- [`unstable`](unstable): Usable APIs. APIs in `ephemeral` will be
12-
occasionally snapshotted and promoted into `unstable`, with approval
11+
- [`snapshot`](snapshot): Usable APIs. APIs in `ephemeral` will be
12+
occasionally snapshotted and promoted into `snapshot`, with approval
1313
from the Subgroup, considering the overall suitability of the APIs
1414
themselves, their documentation, test coverage, and availability of
1515
polyfills when appropriate. Once merged, the API modules will be
1616
considered stable, though they may be superseded by newer versions.
1717
Proposals to promote specific APIs should be submitted as Pull Requests
1818
that:
19-
- Move any superseded files out of `unstable` into `old`.
20-
- Optionally add polyfills for superseded APIs using `unstable` APIs.
21-
- Move all files supporting the APIs out of `ephemeral` into `unstable`.
22-
- Rename the API modules from `wasi_ephemeral_` to `wasi_unstable_`
23-
and append a version number.
19+
1. `git mv` contents of `phases/snapshot/` to `phases/old/snapshot_{old_snapshot_number}`.
20+
1. `cp -R` contents of `phases/ephemeral/` into `phases/snapshot/`.
21+
1. Rename files copied into `phases/snapshot/` to substitute `ephemeral` for `snapshot` in file names. Append the new snapshot number to each name.
22+
1. Update module names given in `.witx` files according to the previous step.
23+
1. Update tests in `tools/witx/tests/wasi.rs` to point at new snapshot, and add a test
24+
pointing at the just-archived snapshot under `old`.
25+
1. Optionally, under `phases/old/snapshot_{old_snapshot_number}, add polyfills for suberseded APIs using the new APIs.
26+
2427

2528
Pull Requests may also add additional tests, documentation, or
26-
polyfills for existing `unstable` APIs.
29+
polyfills for existing `snapshot` APIs.
2730

2831
- [`old`](old): When APIs in `current` spec are replaced by new
2932
versions, the old API modules are moved to the `old` directory. When
@@ -44,7 +47,7 @@ flexibility.
4447

4548
WASI should eventually become a standard at the level of WebAssembly
4649
itself. Right now, it needs a lot of work before it's ready. The
47-
`unstable` tree is meant to serve a practical purpose for people who
50+
`snapshot` tree is meant to serve a practical purpose for people who
4851
want to work with APIs today, with the understanding that everything
4952
is still evolving. It's not meant as a replacement for proper
5053
standardization, which will happen once the overall API is more

0 commit comments

Comments
 (0)