All of lore.kernel.org
 help / color / mirror / Atom feed
From: "embedded (VIVAVIS AG)" <embedded@vivavis.com>
To: "yocto@lists.yoctoproject.org" <yocto@lists.yoctoproject.org>
Subject: State of Yocto styleguide and oe-stylize.py script
Date: Mon, 13 Mar 2023 14:20:02 +0000	[thread overview]
Message-ID: <c607b08fa41a4dfeb70aad68f70f961a@vivavis.com> (raw)

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


             reply	other threads:[~2023-03-13 14:20 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-13 14:20 embedded (VIVAVIS AG) [this message]
2023-03-13 17:14 ` [yocto] State of Yocto styleguide and oe-stylize.py script Khem Raj
2023-03-13 17:34 ` Alexander Kanavin
2023-03-13 17:59   ` Martin Jansa
2023-03-17 12:51     ` AW: " embedded (VIVAVIS AG)
2023-03-17 21:43       ` Tim Orling

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c607b08fa41a4dfeb70aad68f70f961a@vivavis.com \
    --to=embedded@vivavis.com \
    --cc=yocto@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.