There is not a lot of interest in maintaining style guides, and associated tooling. My personal feeling is that they don't really help with the truly problematic things in recipes that need a human eye (or chatgpt level intelligence :) - by and large people do follow reasonable order of entries for example, and nitpicking on an exact order would just be wasting precious maintainer time.
If you want to ensure good quality, making your layer pass the yocto compatibility script, and ensuring there are no warnings of any kind from bitbake when built with latest master revisions of everything is a better first step in my opinion. Alex On Mon, 13 Mar 2023 at 15:20, VIVAVIS AG via lists.yoctoproject.org <embedded=vivavis....@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? > > Thanks for clarification. > > Carsten Stelling > > >
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#59419): https://lists.yoctoproject.org/g/yocto/message/59419 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] -=-=-=-=-=-=-=-=-=-=-=-
