micropython-gcc-plugin/README.md
2025-06-21 15:56:11 +02:00

739 B

Micropython Enhanced Warnings Plugin

This gcc plugin aims to add diagnostics for Micropython core development.

In particular, it handles mp_printf style parameters, finding several apparent problems in the process.

To build the plugin (it must match a specific gcc version and target):

  • Install packages for gcc plugin development (e.g., gcc-12-plugin-dev on debian)
  • Compile it for your specific gcc use case: make CC=cross-gcc
    • This still builds a plugin to execute on the host system (with CXX), despite how it looks

To use it during micropython build:

  • make ... CFLAGS_EXTRA=-fplugin=/path/to/micropython_checks.so

License

GPL-3.0-or-later

Based on original code from https://github.com/rofirrim/gcc-plugins/