Skip to content

Commit 9e71659

Browse files
committed
Add README to semver directory
1 parent c36eff4 commit 9e71659

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

libc-test/semver/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Supported API by libc
2+
3+
These files are read by [`build.rs`](../build.rs) and turned into tests to
4+
ensure that APIs aren't removed between libc releases.
5+
6+
## File order
7+
8+
Files are including in the following order:
9+
* Family, e.g. `unix.txt`. NOTE: Windows is skipped here and includes as OS
10+
name below.
11+
* Vendor, e.g. `apple.txt`. This allows us to have a single file with system
12+
calls shared between multiple OSs, e.g. `ios.txt`, `macos.txt` share the same
13+
kernel.
14+
* OS, e.g `linux.txt`, `macos.txt`, `windows.txt`.
15+
* Architecture specific system calls, e.g. `linux-x86_64.txt` or
16+
`linux-aarch64.txt`.
17+
* Target environment, e.g. `windows-mscv.txt` or `windows-gnu.txt`.

0 commit comments

Comments
 (0)