summaryrefslogtreecommitdiff
path: root/docs/porting.rst
diff options
context:
space:
mode:
authorLucian Copeland <hierophect@gmail.com>2020-04-23 13:33:41 -0400
committerLucian Copeland <hierophect@gmail.com>2020-04-23 13:33:41 -0400
commit8791ca6af3f5a63d286d9f5c3e26f55a1619ff86 (patch)
tree9709829a960b9f7503783b5ca9899a7b65ae52a0 /docs/porting.rst
parentd0a210654767677d6d26f1d4d40c378e03e9ca8e (diff)
implement requested changes
Diffstat (limited to 'docs/porting.rst')
-rw-r--r--docs/porting.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/porting.rst b/docs/porting.rst
index 1fb9d13bc..d28f56f47 100644
--- a/docs/porting.rst
+++ b/docs/porting.rst
@@ -50,7 +50,7 @@ as a natural "TODO" list. An example minimal build list is shown below:
.. code-block:: makefile
- # Items requiring ports/<port>/common-hal implementation:
+ # These modules are implemented in ports/<port>/common-hal:
CIRCUITPY_MICROCONTROLLER = 0 # Typically the first module to create
CIRCUITPY_DIGITALIO = 0 # Typically the second module to create
CIRCUITPY_ANALOGIO = 0
@@ -67,10 +67,11 @@ as a natural "TODO" list. An example minimal build list is shown below:
CIRCUITPY_I2CSLAVE = 0
CIRCUITPY_DISPLAYIO = 0 # Requires SPI, PulseIO (stub ok)
- # Modules with no common-hal implementation, but depend on something else
+ # These modules are implemented in shared-module/ - they can be included in
+ # any port once their prerequisites in common-hal are complete.
CIRCUITPY_BITBANGIO = 0 # Requires DigitalIO
CIRCUITPY_GAMEPAD = 0 # Requires DigitalIO
- CIRCUITPY_PIXELBUF = 0 # Does nothing without a neopixel or dotstar
+ CIRCUITPY_PIXELBUF = 0 # Requires neopixel_write or SPI (dotstar)
CIRCUITPY_RANDOM = 0 # Requires OS
CIRCUITPY_STORAGE = 0 # Requires OS, filesystem
CIRCUITPY_TOUCHIO = 0 # Requires Microcontroller