Documentation for MICROPY_* macros#18585
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
-
One of the things that I find hard to understand is how the various MICROPY_ macros can be used to adjust the capabilities included in the firmware for a particular board or build. More so as I have not been able to find documentation, other than the occasional comment in source. As there are a lot of macros that may benefit from some level of documentation. I have built a simple tool to
the result looks promising :https://gist.github.com/Josverl/9def801af4a80a79de9ae19876efb22f#file-micropy_macros-md now my questions are :
|
BetaWas this translation helpful?Give feedback.
All reactions
👍 2
Thank you for the feedback, and I already saw some referrals, so it seems useful.
I have made some minor adjustments, added a few more macro classes, and generated and added the following pages to the wiki :
- MICROPY_** macros
- MP_** macros
- MBOOT_** macros
- MIMXRT_** macros
All can be found via the (new)wiki index page
I have the module to generate them in a private repo, let me know if you would like access.
Replies: 3 comments 3 replies
-
I think this is useful and should be part of the build/modify documentation. The main documentation could have a summary of what these macros can be used for and include a reference link to this index. The grouping of macros helps a lot. Thanks |
BetaWas this translation helpful?Give feedback.
All reactions
👍 1
-
If I may ask; Would you search for/expect to find them in the docs, or in the wiki? |
BetaWas this translation helpful?Give feedback.
All reactions
-
I would put the general information in the doc, with the details in the Wiki. |
BetaWas this translation helpful?Give feedback.
All reactions
-
A few months ago I actually parsed the codebase for these and built a kconfig frontend to view/configure the build using them. I got quite an effective description for most of them, though I went through a few rounds of broad code exploration to try to get a more complete picture of what the configs did. There were a few aspects of the build system I didn't get working back then but that was a couple of llm generations ago so it would probably be much easier to get cleaned up now! |
BetaWas this translation helpful?Give feedback.
All reactions
-
My first aim is to document, as there is a lot of whitespace. I can see the use of the same info for a Kconfig, but I think that hinges on the clarity and accuracy of the descriptions. It would be interesting to compare the descriptions of your efforts, against these to help validate the good ones , and identify which are incorrect or need to be improved. |
BetaWas this translation helpful?Give feedback.
All reactions
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
-
Thank you for the feedback, and I already saw some referrals, so it seems useful. I have made some minor adjustments, added a few more macro classes, and generated and added the following pages to the wiki :
All can be found via the (new)wiki index page I have the module to generate them in a private repo, let me know if you would like access. |
BetaWas this translation helpful?Give feedback.