search

es-ude / EmbeddedSystemsBuildScripts

Bazel build scripts used for all projects of the embedded systems department
MIT License
4 stars 5 forks source link

Platform definition documentation unclear #9

Open saphieron opened 4 years ago

saphieron commented 4 years ago

Referring to: https://embeddedsystemsbuildscripts.readthedocs.io/en/latest/AvrToolchain.html#how-to-define-your-own-platforms

There does not appear to exist an official list of options in the documentation to specify a platform. E.g. in the README, what does "@AvrToolchain//platforms/misc:hardware_usart" refer to?

glencoe commented 4 years ago

The documentation is not completely on par with the Readme currently. The readme states Use

bazel query 'kind(constraint_setting, @AvrToolchain//platforms/...)'

to receive a list of available platforms.

Nvm... Question is does it make sense to keep a list of descriptions with explanations in the docs, or should we choose clearer names for constraints? Like "has_hardware_usart" for example?