summaryrefslogtreecommitdiffstatshomepage
path: root/docs/reference/glossary.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-08-20 10:11:44 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-08-20 10:11:44 +0300
commit46583e905771222d7b8395e4c33569e2624f1943 (patch)
treec531880f003df6dafa942875a86ece234ad3e9df /docs/reference/glossary.rst
parent3f915704833e2bf8b2d8b977640e8c630c5c5ef7 (diff)
downloadmicropython-46583e905771222d7b8395e4c33569e2624f1943.tar.gz
micropython-46583e905771222d7b8395e4c33569e2624f1943.zip
docs/glossary: Elaborate on possible MicroPython port differences.
State that this doc describes generic, "core" MicroPython functionality, any particular port may diverge in both directions, by both omitting some functionality, and adding more, both cases described outside the generic documentation.
Diffstat (limited to 'docs/reference/glossary.rst')
-rw-r--r--docs/reference/glossary.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/reference/glossary.rst b/docs/reference/glossary.rst
index 4099ae9516..0f93fff23c 100644
--- a/docs/reference/glossary.rst
+++ b/docs/reference/glossary.rst
@@ -68,7 +68,13 @@ Glossary
MicroPython supports different :term:`boards <board>`, RTOSes,
and OSes, and can be relatively easily adapted to new systems.
MicroPython with support for a particular system is called a
- "port" to that system.
+ "port" to that system. Different ports may have widely different
+ functionality. This documentation is intended to be a reference
+ of the generic APIs available across different ports ("MicroPython
+ core"). Note that some ports may still omit some APIs described
+ here (e.g. due to resource constraints). Any such differences,
+ and port-specific extensions beyond MicroPython core functionality,
+ would be described in the separate port-specific documentation.
MicroPython Unix port
Unix port is one of the major :term:`MicroPython ports <MicroPython port>`.