summaryrefslogtreecommitdiff
path: root/sysroot/README
diff options
context:
space:
mode:
Diffstat (limited to 'sysroot/README')
-rw-r--r--sysroot/README52
1 files changed, 52 insertions, 0 deletions
diff --git a/sysroot/README b/sysroot/README
new file mode 100644
index 0000000..93401f8
--- /dev/null
+++ b/sysroot/README
@@ -0,0 +1,52 @@
+
+MCPU sysroot source tree
+========================
+
+This directory is the canonical build-time source image of the target MCPU
+system root. It contains target-facing ABI/configuration material and CRT
+sources; it does not contain manual examples or regression-only emulators.
+
+Runtime-root configuration
+--------------------------
+
+The canonical LibMCPU runtime-root configuration source is:
+
+ sysroot/etc/mcpu-ld.conf
+
+`make install` installs it as:
+
+ <MCPU-root>/etc/mcpu-ld.conf
+
+where `<MCPU-root>` is the configured target MCPU root (normally
+`$(libdir)/mcpu`). The installed runtime path is unchanged; only source-tree
+ownership now follows the sysroot layout.
+
+Assembler ABI headers
+---------------------
+
+The canonical public assembler ABI headers are:
+
+ sysroot/include/sys/asm/
+
+They are the only source used by the LibMCPU build to install
+`<MCPU-root>/include/sys/asm/` and by regression tests that validate the public
+assembler ABI.
+
+HLL CRT
+-------
+
+The canonical LibMCPU CRT assembler sources are:
+
+ sysroot/usr/src/mcpu/crt/
+
+They are assembled out-of-tree into:
+
+ $builddir/sysroot/lib/mcpu/
+
+and `make install` installs `crt0.o`, `crt1.o`, `crti.o`, and `crtn.o` under:
+
+ <MCPU-root>/lib/mcpu/
+
+The target sysroot intentionally contains no `libc-stub` or `hll-emul`
+development trees. HLL/CRT regression fixtures belong to `tests/fixtures/`;
+real MCPU Libc and compiler-output examples are separate projects/packages.