doc/guides: The Big Migration#21708
Conversation
crasbe
added
State: waiting for other PR
|
So will the merging of this PR close #21575? |
|
I'd really love to make that happen but there are 1-2 guides that I don't really want to port as-is but deleting them also doesn't seem like a good option (and I don't have the motivation/time to rewrite them) |
Ive changed my mind on this, its time to end it once and for all >:) |
crasbe
removed
the
State: waiting for other PR
crasbe
added
the
State: needs rebase
AnnsAnns
force-pushed
the
more_migration
branch
from
0658ebc to
38af683
Compare
crasbe
removed
the
State: needs rebase
|
This should be reviewable now :) My favourite part is this: 
This PR also removes GraphViz, as it turns out, we use it for one (unfinished) graph that was part of the porting boards guide, after moving it its now a simple svg (since I wasnt about to add GraphViz to the guide site). The doccheck actually complained about GraphViz having nothing to process so instead of silencing it I decided that I might as well remove graphviz completely. |
|
You marked this as ready for review? If so, you can squash the commits before if you want to. Also there are some undefined references that Doxygen complains about in the static tests. |
Will look into the static test :D Im not really sure how to handle the commits here, one large commit feels a bit problematic, my current idea would be to first get the reviews through and then rebase the PR in the style of: for X in migrated_files: and then a: |
|
That sounds good, but I meant the |
github-actions
bot
added
Area: network
Ah no worries that should be fine, I'd probably do one massive quasi soft reset rewording at the end either way since I expect to fuck it up :P |
crasbe
left a comment
crasbe
left a comment
There was a problem hiding this comment.
Very very superficial look. I know that content changes are not caused by you, but you touch it, you fix it 😋
I will never touch files again 😔 (Im kidding, ty for the review, will work through this tomorrow) |
Co-authored-by: crasbe <[email protected]>
Co-authored-by: crasbe <[email protected]>
Co-authored-by: crasbe <[email protected]>
Co-authored-by: crasbe <[email protected]>
Co-authored-by: crasbe <[email protected]>
Co-authored-by: crasbe <[email protected]>
Co-authored-by: crasbe <[email protected]>
Co-authored-by: crasbe <[email protected]>
Co-authored-by: Marian Buschsieweke <[email protected]>
AnnsAnns
force-pushed
the
more_migration
branch
from
2d053b3 to
ae420f6
Compare
|
Squashed 🦀 (I asked @Teufelchen1 this time I swear) |
|
Thank you for all the reviews 🫡 |
| ## New Style Common Code {#new-style-common-code} | ||
|
|
||
| The common board definitions of RIOT are currently being reworked to make the | ||
| usage of common code easier and less error prone. For example, if you want | ||
| to use the common code for the Adafruit nRF52 Bootloader that is used | ||
| by many of the nRF52 based boards from Adafruit, you simply have to add the | ||
| following line to the `Makefile.dep` of your board. Everything else | ||
| will be automatically included by the build system. | ||
|
|
||
| ```mk | ||
| USEMODULE += boards_common_adafruit-nrf52-bootloader | ||
| ``` | ||
|
|
||
| Not all common code is migrated to the new style yet, so if you are unsure | ||
| whether it is or not, you can check if the `boards/Makefile` already | ||
| includes a reference to the common code you want to use. If you are still | ||
| unsure, you can still use the @ref old-style-common-code or ask the | ||
| community. | ||
|
|
||
| ## Old Style Common Code {#old-style-common-code} | ||
|
|
||
| If you want to use common makefiles, include them at the end of the specific | ||
| `Makefile`, e.g. for a `Makefile.features`: | ||
|
|
||
| ```mk | ||
| CPU = foo | ||
| CPU_MODEL = foobar | ||
|
|
||
| # Put defined MCU peripherals here (in alphabetical order) | ||
| FEATURES_PROVIDED += periph_i2c | ||
| FEATURES_PROVIDED += periph_spi | ||
| FEATURES_PROVIDED += periph_uart | ||
|
|
||
| include $(RIOTBOARD)/common/foo_common/Makefile.features | ||
| ``` | ||
|
|
||
| If the common code includes source files, it might be necessary | ||
| to explicitly include the directory in your `Makefile` so the Make system | ||
| finds all the necessary files: | ||
|
|
||
| ```mk | ||
| MODULE = board | ||
|
|
||
| DIRS += $(RIOTBOARD)/common/myCommonFolder | ||
|
|
||
| include $(RIOTBASE)/Makefile.base | ||
| ``` | ||
|
|
||
| If possible, you should use the @ref new-style-common-code though. |
There was a problem hiding this comment.
This section got removed in your PR :(
And I wondered why it wasn't present anymore...
6 participants
Contribution description
Let's finally migrate all the remaining files from #21575.
This will need to wait for #21706 (or the other way around)
Testing procedure
Issues/PRs references
Depends on #21706.