summaryrefslogtreecommitdiff
path: root/libc-test/semver/README.md
diff options
context:
space:
mode:
authorThomas de Zeeuw <thomasdezeeuw@gmail.com>2021-03-13 15:16:32 +0100
committerThomas de Zeeuw <thomasdezeeuw@gmail.com>2021-03-27 10:27:17 +0100
commit9e71659f573d5e0323373fb272176c7a2408d855 (patch)
treec294ee79d96f5af1fc83c5080890baf6fc5a92e6 /libc-test/semver/README.md
parentc36eff48ad956d4b629aee5bb29bfba0f521eb08 (diff)
downloadrust-libc-9e71659f573d5e0323373fb272176c7a2408d855.tar.gz
Add README to semver directory
Diffstat (limited to 'libc-test/semver/README.md')
-rw-r--r--libc-test/semver/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/libc-test/semver/README.md b/libc-test/semver/README.md
new file mode 100644
index 0000000000..624387172d
--- /dev/null
+++ b/libc-test/semver/README.md
@@ -0,0 +1,17 @@
+# Supported API by libc
+
+These files are read by [`build.rs`](../build.rs) and turned into tests to
+ensure that APIs aren't removed between libc releases.
+
+## File order
+
+Files are including in the following order:
+ * Family, e.g. `unix.txt`. NOTE: Windows is skipped here and includes as OS
+ name below.
+ * Vendor, e.g. `apple.txt`. This allows us to have a single file with system
+ calls shared between multiple OSs, e.g. `ios.txt`, `macos.txt` share the same
+ kernel.
+ * OS, e.g `linux.txt`, `macos.txt`, `windows.txt`.
+ * Architecture specific system calls, e.g. `linux-x86_64.txt` or
+ `linux-aarch64.txt`.
+ * Target environment, e.g. `windows-mscv.txt` or `windows-gnu.txt`.