| Message ID | 20250610101926.2235143-1-ross.burton@arm.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | ref-manual: classes: add recipe-naming QA test | expand |
On Tue Jun 10, 2025 at 12:19 PM CEST, Ross Burton via lists.yoctoproject.org wrote: > Add documentation for the new recipe-naming recipe QA test. > > Signed-off-by: Ross Burton <ross.burton@arm.com> > --- > documentation/ref-manual/classes.rst | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst > index 54a98bf24f3..9be1c2c587c 100644 > --- a/documentation/ref-manual/classes.rst > +++ b/documentation/ref-manual/classes.rst > @@ -1591,6 +1591,10 @@ The tests you can list with the :term:`WARN_QA` and > For example, assignments such as ``FILES:${PN} = "xyz"`` effectively > turn into ``FILES = "xyz"``. > > +- ``recipe-naming:`` Checks that the recipe name and recipe class match, so > + inherit :term:`nativesdk`. :term: are not defined for those, but :ref:`ref-classes-native` and :ref:`ref-classes-nativesdk` are. Maybe also say that BBCLASSEXTEND should be set appropriately, so users encountering the issue know what to do? > + > - ``rpaths:`` Checks for rpaths in the binaries that contain build > system paths such as :term:`TMPDIR`. If this test fails, bad ``-rpath`` > options are being passed to the linker commands and your binaries Antonin
Hi Ross, On 6/10/25 12:19 PM, Ross Burton via lists.yoctoproject.org wrote: > Add documentation for the new recipe-naming recipe QA test. > > Signed-off-by: Ross Burton <ross.burton@arm.com> > --- > documentation/ref-manual/classes.rst | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst > index 54a98bf24f3..9be1c2c587c 100644 > --- a/documentation/ref-manual/classes.rst > +++ b/documentation/ref-manual/classes.rst > @@ -1591,6 +1591,10 @@ The tests you can list with the :term:`WARN_QA` and > For example, assignments such as ``FILES:${PN} = "xyz"`` effectively > turn into ``FILES = "xyz"``. > > +- ``recipe-naming:`` Checks that the recipe name and recipe class match, so > + that ``*-native`` recipes inherit :term:`native` and ``nativesdk-*`` recipes > + inherit :term:`nativesdk`. > + For native/nativesdk after the "inherit" word, prefer pointing at the class documentation, e.g. :ref:`ref-classes-native` and :ref:`ref-classes-nativesdk`. Maybe you could reword into: that :term:`native` recipes whose name ends with ``*-native`` inherit :ref:`ref-classes-native` and :term:`nativesdk` recipes whose name starts with ``nativesdk-*`` inherit :ref:`ref-classes-nativesdk`. What do you think? Looks good to me otherwise, thanks! Cheers, Quentin
On Tue Jun 10, 2025 at 1:10 PM CEST, Antonin Godard wrote: > On Tue Jun 10, 2025 at 12:19 PM CEST, Ross Burton via lists.yoctoproject.org wrote: >> Add documentation for the new recipe-naming recipe QA test. >> >> Signed-off-by: Ross Burton <ross.burton@arm.com> >> --- >> documentation/ref-manual/classes.rst | 4 ++++ >> 1 file changed, 4 insertions(+) >> >> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst >> index 54a98bf24f3..9be1c2c587c 100644 >> --- a/documentation/ref-manual/classes.rst >> +++ b/documentation/ref-manual/classes.rst >> @@ -1591,6 +1591,10 @@ The tests you can list with the :term:`WARN_QA` and >> For example, assignments such as ``FILES:${PN} = "xyz"`` effectively >> turn into ``FILES = "xyz"``. >> >> +- ``recipe-naming:`` Checks that the recipe name and recipe class match, so > >> + inherit :term:`nativesdk`. > > :term: are not defined for those, but :ref:`ref-classes-native` and > :ref:`ref-classes-nativesdk` are. > > Maybe also say that BBCLASSEXTEND should be set appropriately, so users > encountering the issue know what to do? Sorry I got confused, recipes need to `inherit` one class or the other, so BBCLASSEXTEND is not needed! Antonin
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 54a98bf24f3..9be1c2c587c 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -1591,6 +1591,10 @@ The tests you can list with the :term:`WARN_QA` and For example, assignments such as ``FILES:${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. +- ``recipe-naming:`` Checks that the recipe name and recipe class match, so + that ``*-native`` recipes inherit :term:`native` and ``nativesdk-*`` recipes + inherit :term:`nativesdk`. + - ``rpaths:`` Checks for rpaths in the binaries that contain build system paths such as :term:`TMPDIR`. If this test fails, bad ``-rpath`` options are being passed to the linker commands and your binaries
Add documentation for the new recipe-naming recipe QA test. Signed-off-by: Ross Burton <ross.burton@arm.com> --- documentation/ref-manual/classes.rst | 4 ++++ 1 file changed, 4 insertions(+)