summaryrefslogtreecommitdiffstats
path: root/libc/docs/ground_truth_specification.rst
diff options
context:
space:
mode:
Diffstat (limited to 'libc/docs/ground_truth_specification.rst')
-rw-r--r--libc/docs/ground_truth_specification.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/libc/docs/ground_truth_specification.rst b/libc/docs/ground_truth_specification.rst
new file mode 100644
index 00000000000..f2540b6f78e
--- /dev/null
+++ b/libc/docs/ground_truth_specification.rst
@@ -0,0 +1,11 @@
+The ground truth of standards
+=============================
+
+Like any modern libc, LLVM libc also supports a wide number of standards and
+extensions. To avoid developing headers, wrappers and sources in a disjointed
+fashion, LLVM libc employs ground truth files. These files live under the
+``spec`` directory and list ground truth corresponding the ISO C standard, the
+POSIX extension standard, etc. For example, the path to the ground truth file
+for the ISO C standard is ``spec/stdc.td``. Tools like the header generator
+(described in the header generation document), docs generator, etc. use the
+ground truth files to generate headers, docs etc.
OpenPOWER on IntegriCloud