On 3/13/23 7:20 AM, VIVAVIS AG via lists.yoctoproject.org wrote:
Hi,I'm wondering whether the styleguide www.openembedded.org/wiki/Styleguide, meta-openembedded/contrib/oe-stylize.py or none of them is the source of truth for writing a good recipe. E.g., if you run oe-stylize.py, the SRCREV variable is placed above SRC_URI, or RDEPENDS is placed above FILES, which is not what the Wiki documents. And there are more discrepancies of this type. Furthermore, the script doesn't know the FILESEXTRAPATHS variable in bbappend files and moves it to the end of my recipe. Well, this is not decribed in the Wiki, but a look into append files in meta-openembedded shows, that it is common pactice to put FILESEXTRAPATHS in the first line of the recipe. The Wiki has an interesting note and the end: "You can run contrib/oe-stylize.py from meta-oe on your recipes before submitting them; however it is not necessarily up-to-date with all current style conventions. This page should be considered the canonical reference." Furthermore, there's github.com/openembedded/meta-openembedded/pull/465 providing another ruleset for the new linter. So, my question to the Yocto maintainers is, what is the current state of the styleguide and oe-stylize.py? Are there plans to synchronize them?
oe-stylize.py is still the linter of choice but as you have noted it has been lacking on certain areas and wiki should be updated to match what it produces. It does need some TLC and patches are welcome.
Thanks for clarification. Carsten Stelling
OpenPGP_0xBB053355919D3314.asc
Description: OpenPGP public key
OpenPGP_signature
Description: OpenPGP digital signature
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#59418): https://lists.yoctoproject.org/g/yocto/message/59418 Mute This Topic: https://lists.yoctoproject.org/mt/97581374/21656 Group Owner: yocto+ow...@lists.yoctoproject.org Unsubscribe: https://lists.yoctoproject.org/g/yocto/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-