aboutsummaryrefslogtreecommitdiff
path: root/docs/develop/cmodules.rst
AgeCommit message (Collapse)Author
2021-04-02docs/develop: Improve user C modules to properly describe how to build.Damien George
Make and CMake builds are slightly different and these changes help make it clear what to do in each case. Signed-off-by: Damien George <damien@micropython.org>
2021-04-01examples/usercmodules: Simplify user C module enabling.Damien George
It's a bit of a pitfall with user C modules that including them in the build does not automatically enable them. This commit changes the docs and examples for user C modules to encourage writers of user C modules to enable them unconditionally. This makes things simpler and covers most use cases. See discussion in issue #6960, and also #7086. Signed-off-by: Damien George <damien@micropython.org>
2021-03-31docs/develop/cmodules.rst: Document C-modules and micropython.cmake.Phil Howard
Documents the micropython.cmake file required to make user C modules compatible with the CMake build system. Signed-off-by: Phil Howard <phil@pimoroni.com>
2020-10-29docs/develop/cmodules.rst: Add link to source code for user C example.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2020-10-29examples: Add example code for user C modules, both C and C++.stijn
Add working example code to provide a starting point for users with files that they can just copy, and include the modules in the coverage test to verify the complete user C module build functionality. The cexample module uses the code originally found in cmodules.rst, which has been updated to reflect this and partially rewritten with more complete information.
2020-10-29py/py.mk: Support C++ code for user C modules.stijn
Support C++ code in .cpp files by providing CXX counterparts of the _USERMOD_ flags we have for C already. This merely enables the Makefile of user C modules to use variables specific to C++ compilation, it is still up to each port's main Makefile to also include these in the build.
2020-01-06docs: More consistent capitalization and use of articles in headings.Jason Neal
See issue #3188.
2019-12-19docs/develop: Add documentation on how to build native .mpy modules.Damien George
2019-04-18docs/cmodules: Note the various ways MODULE_EXAMPLE_ENABLED can be set.Daniel O'Connor
2019-04-15docs/cmodules: Fix example to globally define MODULE_EXAMPLE_ENABLED.Daniel O'Connor
MODULE_EXAMPLE_ENABLED must be globally defined for the module to be seen and referenced by all parts of the code.
2019-03-13docs/develop: Fix typos in C-module example for example_add_ints.Martin Fischer
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.