aboutsummaryrefslogtreecommitdiff
path: root/std_overrides/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'std_overrides/README.md')
-rw-r--r--std_overrides/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/std_overrides/README.md b/std_overrides/README.md
new file mode 100644
index 00000000..06398c0f
--- /dev/null
+++ b/std_overrides/README.md
@@ -0,0 +1,18 @@
+### CHRE Overrides
+
+CHRE provides nanoapps with a minimal list of overrides to standard library
+functions that are not supported by CHRE, but can be redirected to a supported
+function, or when failing silently should be of minimal consequences to the
+nanoapp. Two possible scenarios where the developers might need to use these
+overrides are:
+
+* Generated code
+* Third-party code/libraries
+
+The overrides makefile is included in the nanoapp build by default, but the
+developers need to enable it by setting a flag in the nanoapp Makefile:
+`CHRE_STD_OVERRIDES_ALLOWED = true`
+
+It is expected that the nanoapp developers only leverage these overrides while
+working towards zero overrides usage.
+