summaryrefslogtreecommitdiff
path: root/tools/gen-cpydiff.py
AgeCommit message (Collapse)Author
2017-07-31all: Use the name MicroPython consistently in commentsAlexander Steffen
There were several different spellings of MicroPython present in comments, when there should be only one.
2017-07-09tools/gen-cpydiff: Use case description as 3rd-level heading.Paul Sokolovsky
This is required to easily giving links to a particular difference case. Also, add RST anchors to allow cases to cross-reference each other.
2017-02-27tools/gen-cpydiff.py: configurable CPython and micropython executablesKrzysztof Blazewicz
2017-02-22tools/gen-cpydiff.py: Set the Python import path to find test modules.Damien George
2017-02-20tools: Add gen-cpydiff.py to generate docs differences.Rami Ali
This patch introduces the a small framework to track differences between uPy and CPython. The framework consists of: - A set of "tests" which test for an individual feature that differs between uPy and CPy. Each test is like a normal uPy test in the test suite, but has a special comment at the start with some meta-data: a category (eg syntax, core language), a human-readable description of the difference, a cause, and a workaround. Following the meta-data there is a short code snippet which demonstrates the difference. See tests/cpydiff directory for the initial set of tests. - A program (this patch) which runs all the tests (on uPy and CPy) and generates nicely-formated .rst documenting the differences. - Integration into the docs build so that everything is automatic, and the differences appear in a way that is easy for users to read/reference (see latter commits). The idea with using this new framework is: - When a new difference is found it's easy to write a short test for it, along with a description, and add it to the existing ones. It's also easy for contributors to submit tests for differences they find. - When something is no longer different the tool will give an error and difference can be removed (or promoted to a proper feature test).