summaryrefslogtreecommitdiff
path: root/docs/reference
AgeCommit message (Collapse)Author
2021-02-13tools: Add filesystem action examples to pyboard.py help.Brianna Laugher
Signed-off-by: Brianna Laugher <brianna.laugher@gmail.com>
2020-12-01docs/reference/repl.rst: Add information about new raw-paste mode.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2020-10-22docs/reference/glossary.rst: Fix minor grammar error, An -> A.Kevin Thomas
2020-09-30docs/reference/packages.rst: Fix typo, remove duplicate "port".David Lechner
Fixes #6485.
2020-06-05docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.David Lechner
This enables warnings as errors and fixes all current errors, namely: - reference to terms in the glossary must now be explicit (:term:) - method overloads must not be declared as a separate method or must use :noindex: - 2 cases where `` should have been used instead of `
2020-06-02docs/reference: Add note about multiple exceptions when heap is locked.Andrew Leech
2020-04-04esp8266: Change from FAT to littlefs v2 as default filesystem.Damien George
This commit changes the esp8266 boards to use littlefs v2 as the filesystem, rather than FAT. Since the esp8266 doesn't expose the filesystem to the PC over USB there's no strong reason to keep it as FAT. Littlefs is smaller in code size, is more efficient in use of flash to store data, is resilient over power failure, and using it saves about 4k of heap RAM, which can now be used for other things. This is a backwards incompatible change because all existing esp8266 boards will need to update their filesystem after installing new firmware (eg backup old files, install firmware, restore files to new filesystem). As part of this commit the memory layout of the default board (GENERIC) has changed. It now allocates all 1M of memory-mapped flash to the firmware, so the filesystem area starts at the 2M point. This is done to allow more frozen bytecode to be stored in the 1M of memory-mapped flash. This requires an esp8266 module with 2M or more of flash to work, so a new board called GENERIC_1M is added which has the old memory-mapping (but still changed to use littlefs for the filesystem). In summary there are now 3 esp8266 board definitions: - GENERIC_512K: for 512k modules, doesn't have a filesystem. - GENERIC_1M: for 1M modules, 572k for firmware+frozen code, 396k for filesystem (littlefs). - GENERIC: for 2M (or greater) modules, 968k for firmware+frozen code, 1M+ for filesystem (littlefs), FAT driver also included in firmware for use on, eg, external SD cards.
2020-03-30tools/pyboard.py: Add -d as an alias for --device.Lars Kellogg-Stedman
2020-03-30tools/pyboard.py: Support setting device/baudrate from shell env vars.Lars Kellogg-Stedman
Allow defaults for --device and --baudrate to be set in the environment using PYBOARD_DEVICE and PYBOARD_BAUDRATE.
2020-01-06docs: More consistent capitalization and use of articles in headings.Jason Neal
See issue #3188.
2019-12-19docs/reference: Add documentation describing use of .mpy files.Damien George
Including information about .mpy versioning and how to debug failed imports of .mpy files.
2019-12-10docs/library/uos: Add notes and links about littlefs failures.Damien George
2019-12-09docs/reference/filesystem: Add note and example about using filesystem.Damien George
2019-12-09docs/reference/filesystem: Fix typo in block device code example.Daniel Mizyrycki
2019-12-04docs: Add littlefs docs and a filesystem tutorial.Jim Mussared
2019-12-04docs/reference: Add docs describing use of pyboard.py.Jim Mussared
2019-12-04docs: Remove spaces on lines that are empty.Damien George
2019-10-16docs: Fix spelling in various parts of the docs.Mike Causer
2019-10-15docs/reference/glossary.rst: Add new terms and reduce complexity of old.Jim Mussared
2019-08-28docs/reference/speed_python: Add missing self to var caching example.Paul m. p. P
2019-08-19docs/reference/speed_python: Update that read-only buffers are accepted.Peter Hinch
As allowed by recent cd35dd9d9a29836906acdce60c931f6352b536d0
2019-03-08py: Update and rework build system for including external C modules.Andrew Leech
How to use this feature is documented in docs/develop/cmodules.rst.
2019-03-08py: Implement a module system for external, user C modules.Ayke van Laethem
This system makes it a lot easier to include external libraries as static, native modules in MicroPython. Simply pass USER_C_MODULES (like FROZEN_MPY_DIR) as a make parameter.
2019-02-12all: Change PYB message prefix to MPY.Mike Causer
Replaces "PYB: soft reboot" with "MPY: soft reboot", etc. Having a consistent prefix across ports reduces the difference between ports, which is a general goal. And this change won't break pyboard.py because that tool only looks for "soft reboot".
2018-07-20docs/reference/index: Remove conditional for inline asm docs.Damien George
The heading of this section makes it clear it is for Thumb-2 architectures only.
2018-03-15docs: Fix some references and RST markup to eliminate Sphinx warnings.Damien George
2018-03-09docs/reference/repl.rst: Fix some minor errors in the REPL tutorial.Damien George
2017-12-16docs/packages: Explicitly recommend usage of setuptools instead of distutils.Paul Sokolovsky
2017-12-16docs/packages: Use "install_dir/" in examples.Paul Sokolovsky
2017-12-15docs/glossary: micropython-lib: Clarify wording.Paul Sokolovsky
2017-12-14docs/packages: mpy_bin2res no longer required to create resources.Paul Sokolovsky
Everything happens automagically with overridden "sdist" from sdist_upip.py.
2017-12-13docs/packages: Add quick "Creating distribution packages" section.Paul Sokolovsky
Needs more details.
2017-12-11docs/reference/packages: Add chapter on distribution packages and deployment.Paul Sokolovsky
A long overdue overview of preparing packages, installing them with upip, freezing, dealing with resources. Initial version, more iterations required.
2017-12-06docs/glossary: Clarify wording for "baremetal".Paul Sokolovsky
2017-12-04docs/glossary: Describe string interning.Paul Sokolovsky
2017-12-03docs/glossary: Describe "stream" term.Paul Sokolovsky
2017-12-03docs/glossary: Describe the callee-owned tuple concept.Paul Sokolovsky
2017-11-23docs: Add notes on heap allocation caused by bound method refs.Peter Hinch
2017-10-30docs/reference/isr_rules: Minor typo correction.Yuval Langer
2017-09-09docs/reference/isr_rules.rst Add tutorial on use of micropython.schedule().Peter Hinch
2017-09-06all: Update Makefiles and others to build with new ports/ dir layout.Damien George
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-08-28docs: More xrefs to "MicroPython port" in glossary.Paul Sokolovsky
2017-08-20docs/glossary: Fix typos in micropython-lib paragraph.Paul Sokolovsky
2017-08-20docs/glossary: Elaborate on possible MicroPython port differences.Paul Sokolovsky
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.
2017-07-02docs: Add glossary.Paul Sokolovsky
We have enough terms or references throughout the docs which may be not immediately clear or have some important nuances. Referencing terms in gloassary is the best way to deal with that.
2017-07-01reference/index: Rewrite introduction paragraph to avoid confusion.Paul Sokolovsky
The old intro talked about "differences", but there were hardly any sections describing differences, mostly MicroPython specific features. On the other hand, we now have real "differences" chapter, though it's mostly concerned with stdlib differences. So, try to avoid confusion by changing wording and linking to the other chapters and contrasting them with what is described in "MicroPython language".
2017-07-01docs/constrained: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-26docs/ref/speed_python: Update and make more hardware-neutral.Paul Sokolovsky
Move hardware-specific optimizations to the very end of document, and add visible note that it gives an example for Pyboard. Remove references to specific hardware technologies, so the doc can be more naturally used across ports. Various markup updates to adhere to the latest docs conventions.
2016-11-08docs/*/quickref.rst: Use new semantics of ticks_diff()puuu
2016-10-11docs/reference: Add constrained.rst doc.Peter Hinch
It contains detailed information about writing scripts to run efficiently on microcontrollers (and other constrained systems).