All of lore.kernel.org
 help / color / mirror / Atom feed
* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
       [not found] <16959EEB5BD85597.12821@lists.yoctoproject.org>
@ 2021-07-27 10:29 ` Michael Opdenacker
  2021-07-27 11:23   ` Quentin Schulz
  0 siblings, 1 reply; 9+ messages in thread
From: Michael Opdenacker @ 2021-07-27 10:29 UTC (permalink / raw)
  To: docs, Quentin Schulz

Hello Quentin,

On 7/27/21 12:26 PM, Michael Opdenacker wrote:
> These files are not used to build to documentation
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  .../examples/hello-autotools/hello_2.10.bb      |  9 ---------
>  .../examples/hello-single/files/helloworld.c    |  8 --------
>  .../ref-manual/examples/hello-single/hello.bb   | 17 -----------------
>  .../ref-manual/examples/libxpm/libxpm_3.5.6.bb  | 14 --------------
>  .../examples/mtd-makefile/mtd-utils_1.0.0.bb    | 15 ---------------
>  5 files changed, 63 deletions(-)
>  delete mode 100644 documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
>  delete mode 100644 documentation/ref-manual/examples/hello-single/files/helloworld.c
>  delete mode 100644 documentation/ref-manual/examples/hello-single/hello.bb
>  delete mode 100644 documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
>  delete mode 100644 documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
>
> diff --git a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb b/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> deleted file mode 100644
> index aa2beb9a9b..0000000000
> --- a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> +++ /dev/null
> @@ -1,9 +0,0 @@
> -DESCRIPTION = "GNU Helloworld application"
> -SECTION = "examples"
> -LICENSE = "GPLv3"
> -LIC_FILES_CHKSUM = "file://COPYING;md5=d32239bcb673463ab874e80d47fae504"
> -
> -SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz"
> -SRC_URI[sha256sum] = "31e066137a962676e89f69d1b65382de95a7ef7d914b8cb956f41ea72e0f516b"
> -
> -inherit autotools-brokensep gettext
> diff --git a/documentation/ref-manual/examples/hello-single/files/helloworld.c b/documentation/ref-manual/examples/hello-single/files/helloworld.c
> deleted file mode 100644
> index fc7169b7b8..0000000000
> --- a/documentation/ref-manual/examples/hello-single/files/helloworld.c
> +++ /dev/null
> @@ -1,8 +0,0 @@
> -#include <stdio.h>
> -
> -int main(void)
> -{
> -	printf("Hello world!\n");
> -
> -	return 0;
> -}
> diff --git a/documentation/ref-manual/examples/hello-single/hello.bb b/documentation/ref-manual/examples/hello-single/hello.bb
> deleted file mode 100644
> index 90d3aefd86..0000000000
> --- a/documentation/ref-manual/examples/hello-single/hello.bb
> +++ /dev/null
> @@ -1,17 +0,0 @@
> -DESCRIPTION = "Simple helloworld application"
> -SECTION = "examples"
> -LICENSE = "MIT"
> -LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
> -
> -SRC_URI = "file://helloworld.c"
> -
> -S = "${WORKDIR}"
> -
> -do_compile() {
> -	${CC} ${LDFLAGS} helloworld.c -o helloworld
> -}
> -
> -do_install() {
> -	install -d ${D}${bindir}
> -	install -m 0755 helloworld ${D}${bindir}
> -}
> diff --git a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb b/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> deleted file mode 100644
> index c0c8986405..0000000000
> --- a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> +++ /dev/null
> @@ -1,14 +0,0 @@
> -require recipes-graphics/xorg-lib/xorg-lib-common.inc
> -
> -DESCRIPTION = "X11 Pixmap library"
> -LICENSE = "X-BSD"
> -LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5"
> -DEPENDS += "libxext"
> -PR = "r2"
> -PE = "1"
> -
> -XORG_PN = "libXpm"
> -
> -PACKAGES =+ "sxpm cxpm"
> -FILES_cxpm = "${bindir}/cxpm"
> -FILES_sxpm = "${bindir}/sxpm"
> diff --git a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb b/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> deleted file mode 100644
> index 5d05a437a4..0000000000
> --- a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> +++ /dev/null
> @@ -1,15 +0,0 @@
> -DESCRIPTION = "Tools for managing memory technology devices."
> -SECTION = "base"
> -DEPENDS = "zlib"
> -HOMEPAGE = "http://www.linux-mtd.infradead.org/"
> -LICENSE = "GPLv2"
> -LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
> -                    file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"
> -
> -SRC_URI = "ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-${PV}.tar.gz"
> -
> -CFLAGS_prepend = "-I ${S}/include "
> -
> -do_install() {
> -	oe_runmake install DESTDIR=${D}
> -}
>

This is probably a controversial commit. Rather than asking a question,
I preferred to send a patch.

Apparently, you were the last one to touch these files, so don't
hesitate to stop me and let us know why we should keep these files.
Maybe to make sure that our examples still compile? However, I found at
least one file that is not in sync with the contents of the documentation.

Thanks in advance,
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
  2021-07-27 10:29 ` [docs] [PATCH] ref-manual: remove unused example recipe source files Michael Opdenacker
@ 2021-07-27 11:23   ` Quentin Schulz
  2021-07-27 11:38     ` Richard Purdie
  0 siblings, 1 reply; 9+ messages in thread
From: Quentin Schulz @ 2021-07-27 11:23 UTC (permalink / raw)
  To: Michael Opdenacker; +Cc: docs, Quentin Schulz

Hi Michael,

On Tue, Jul 27, 2021 at 12:29:41PM +0200, Michael Opdenacker wrote:
> Hello Quentin,
> 
> On 7/27/21 12:26 PM, Michael Opdenacker wrote:
> > These files are not used to build to documentation
> >
> > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > ---
> >  .../examples/hello-autotools/hello_2.10.bb      |  9 ---------
> >  .../examples/hello-single/files/helloworld.c    |  8 --------
> >  .../ref-manual/examples/hello-single/hello.bb   | 17 -----------------
> >  .../ref-manual/examples/libxpm/libxpm_3.5.6.bb  | 14 --------------
> >  .../examples/mtd-makefile/mtd-utils_1.0.0.bb    | 15 ---------------
> >  5 files changed, 63 deletions(-)
> >  delete mode 100644 documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> >  delete mode 100644 documentation/ref-manual/examples/hello-single/files/helloworld.c
> >  delete mode 100644 documentation/ref-manual/examples/hello-single/hello.bb
> >  delete mode 100644 documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> >  delete mode 100644 documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> >
> > diff --git a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb b/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> > deleted file mode 100644
> > index aa2beb9a9b..0000000000
> > --- a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> > +++ /dev/null
> > @@ -1,9 +0,0 @@
> > -DESCRIPTION = "GNU Helloworld application"
> > -SECTION = "examples"
> > -LICENSE = "GPLv3"
> > -LIC_FILES_CHKSUM = "file://COPYING;md5=d32239bcb673463ab874e80d47fae504"
> > -
> > -SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz"
> > -SRC_URI[sha256sum] = "31e066137a962676e89f69d1b65382de95a7ef7d914b8cb956f41ea72e0f516b"
> > -
> > -inherit autotools-brokensep gettext
> > diff --git a/documentation/ref-manual/examples/hello-single/files/helloworld.c b/documentation/ref-manual/examples/hello-single/files/helloworld.c
> > deleted file mode 100644
> > index fc7169b7b8..0000000000
> > --- a/documentation/ref-manual/examples/hello-single/files/helloworld.c
> > +++ /dev/null
> > @@ -1,8 +0,0 @@
> > -#include <stdio.h>
> > -
> > -int main(void)
> > -{
> > -	printf("Hello world!\n");
> > -
> > -	return 0;
> > -}
> > diff --git a/documentation/ref-manual/examples/hello-single/hello.bb b/documentation/ref-manual/examples/hello-single/hello.bb
> > deleted file mode 100644
> > index 90d3aefd86..0000000000
> > --- a/documentation/ref-manual/examples/hello-single/hello.bb
> > +++ /dev/null
> > @@ -1,17 +0,0 @@
> > -DESCRIPTION = "Simple helloworld application"
> > -SECTION = "examples"
> > -LICENSE = "MIT"
> > -LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
> > -
> > -SRC_URI = "file://helloworld.c"
> > -
> > -S = "${WORKDIR}"
> > -
> > -do_compile() {
> > -	${CC} ${LDFLAGS} helloworld.c -o helloworld
> > -}
> > -
> > -do_install() {
> > -	install -d ${D}${bindir}
> > -	install -m 0755 helloworld ${D}${bindir}
> > -}
> > diff --git a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb b/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> > deleted file mode 100644
> > index c0c8986405..0000000000
> > --- a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> > +++ /dev/null
> > @@ -1,14 +0,0 @@
> > -require recipes-graphics/xorg-lib/xorg-lib-common.inc
> > -
> > -DESCRIPTION = "X11 Pixmap library"
> > -LICENSE = "X-BSD"
> > -LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5"
> > -DEPENDS += "libxext"
> > -PR = "r2"
> > -PE = "1"
> > -
> > -XORG_PN = "libXpm"
> > -
> > -PACKAGES =+ "sxpm cxpm"
> > -FILES_cxpm = "${bindir}/cxpm"
> > -FILES_sxpm = "${bindir}/sxpm"
> > diff --git a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb b/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> > deleted file mode 100644
> > index 5d05a437a4..0000000000
> > --- a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> > +++ /dev/null
> > @@ -1,15 +0,0 @@
> > -DESCRIPTION = "Tools for managing memory technology devices."
> > -SECTION = "base"
> > -DEPENDS = "zlib"
> > -HOMEPAGE = "https://urldefense.proofpoint.com/v2/url?u=http-3A__www.linux-2Dmtd.infradead.org_&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=eyb4BYFT9E-HdgVPGQm8pJMdNlXGefc8FzxjWoAmrcs&s=rDxXZI7Evhz9_J8vJmFmp7sfSRycLIHpvHm2-rhxYYQ&e= "
> > -LICENSE = "GPLv2"
> > -LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
> > -                    file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"
> > -
> > -SRC_URI = "https://urldefense.proofpoint.com/v2/url?u=ftp-3A__ftp.infradead.org_pub_mtd-2Dutils_mtd-2Dutils-2D-24-257BPV-257D.tar.gz&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=eyb4BYFT9E-HdgVPGQm8pJMdNlXGefc8FzxjWoAmrcs&s=iW6rRvnv1zLX6sYtZjtYVLji9LdaUjp64SzvLGJhKC0&e= "
> > -
> > -CFLAGS_prepend = "-I ${S}/include "
> > -
> > -do_install() {
> > -	oe_runmake install DESTDIR=${D}
> > -}
> >
> 
> This is probably a controversial commit. Rather than asking a question,
> I preferred to send a patch.
> 
> Apparently, you were the last one to touch these files, so don't
> hesitate to stop me and let us know why we should keep these files.
> Maybe to make sure that our examples still compile? However, I found at
> least one file that is not in sync with the contents of the documentation.
> 

I wouldn't remove them as I find example recipes to be very welcomed as
real life examples of what can/needs to be done. It shows also some
gotchas and what a minimal recipe should look like.

What I have to complain about those files currently is that they are not
built and they weren't working for a while, which is a bit of a shame
for example recipes :)

I don't think keeping them in the yocto-docs is something we want to
push for (at least I won't), but I feel like we should keep them
somewhere they are built so we maintain them along other recipes.

I can see that we have a recipe for an out-of-tree kernel drievr recipe
available in poky/meta-skeleton layer (called hello-mod). I guess this
is a place we could put the examples you want to remove from yocto-docs?

Cheers,
Quentin

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
  2021-07-27 11:23   ` Quentin Schulz
@ 2021-07-27 11:38     ` Richard Purdie
  2021-07-27 12:36       ` Michael Opdenacker
       [not found]       ` <1695A60376DC3ECA.18160@lists.yoctoproject.org>
  0 siblings, 2 replies; 9+ messages in thread
From: Richard Purdie @ 2021-07-27 11:38 UTC (permalink / raw)
  To: Quentin Schulz, Michael Opdenacker; +Cc: docs, Quentin Schulz

On Tue, 2021-07-27 at 13:23 +0200, Quentin Schulz wrote:
> Hi Michael,
> 
> On Tue, Jul 27, 2021 at 12:29:41PM +0200, Michael Opdenacker wrote:
> > Hello Quentin,
> > 
> > On 7/27/21 12:26 PM, Michael Opdenacker wrote:
> > > These files are not used to build to documentation
> > > 
> > > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > > ---
> > >  .../examples/hello-autotools/hello_2.10.bb      |  9 ---------
> > >  .../examples/hello-single/files/helloworld.c    |  8 --------
> > >  .../ref-manual/examples/hello-single/hello.bb   | 17 -----------------
> > >  .../ref-manual/examples/libxpm/libxpm_3.5.6.bb  | 14 --------------
> > >  .../examples/mtd-makefile/mtd-utils_1.0.0.bb    | 15 ---------------
> > >  5 files changed, 63 deletions(-)
> > >  delete mode 100644 documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> > >  delete mode 100644 documentation/ref-manual/examples/hello-single/files/helloworld.c
> > >  delete mode 100644 documentation/ref-manual/examples/hello-single/hello.bb
> > >  delete mode 100644 documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> > >  delete mode 100644 documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> > > 
> > > diff --git a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb b/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> > > deleted file mode 100644
> > > index aa2beb9a9b..0000000000
> > > --- a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
> > > +++ /dev/null
> > > @@ -1,9 +0,0 @@
> > > -DESCRIPTION = "GNU Helloworld application"
> > > -SECTION = "examples"
> > > -LICENSE = "GPLv3"
> > > -LIC_FILES_CHKSUM = "file://COPYING;md5=d32239bcb673463ab874e80d47fae504"
> > > -
> > > -SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz"
> > > -SRC_URI[sha256sum] = "31e066137a962676e89f69d1b65382de95a7ef7d914b8cb956f41ea72e0f516b"
> > > -
> > > -inherit autotools-brokensep gettext
> > > diff --git a/documentation/ref-manual/examples/hello-single/files/helloworld.c b/documentation/ref-manual/examples/hello-single/files/helloworld.c
> > > deleted file mode 100644
> > > index fc7169b7b8..0000000000
> > > --- a/documentation/ref-manual/examples/hello-single/files/helloworld.c
> > > +++ /dev/null
> > > @@ -1,8 +0,0 @@
> > > -#include <stdio.h>
> > > -
> > > -int main(void)
> > > -{
> > > -	printf("Hello world!\n");
> > > -
> > > -	return 0;
> > > -}
> > > diff --git a/documentation/ref-manual/examples/hello-single/hello.bb b/documentation/ref-manual/examples/hello-single/hello.bb
> > > deleted file mode 100644
> > > index 90d3aefd86..0000000000
> > > --- a/documentation/ref-manual/examples/hello-single/hello.bb
> > > +++ /dev/null
> > > @@ -1,17 +0,0 @@
> > > -DESCRIPTION = "Simple helloworld application"
> > > -SECTION = "examples"
> > > -LICENSE = "MIT"
> > > -LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
> > > -
> > > -SRC_URI = "file://helloworld.c"
> > > -
> > > -S = "${WORKDIR}"
> > > -
> > > -do_compile() {
> > > -	${CC} ${LDFLAGS} helloworld.c -o helloworld
> > > -}
> > > -
> > > -do_install() {
> > > -	install -d ${D}${bindir}
> > > -	install -m 0755 helloworld ${D}${bindir}
> > > -}
> > > diff --git a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb b/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> > > deleted file mode 100644
> > > index c0c8986405..0000000000
> > > --- a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
> > > +++ /dev/null
> > > @@ -1,14 +0,0 @@
> > > -require recipes-graphics/xorg-lib/xorg-lib-common.inc
> > > -
> > > -DESCRIPTION = "X11 Pixmap library"
> > > -LICENSE = "X-BSD"
> > > -LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5"
> > > -DEPENDS += "libxext"
> > > -PR = "r2"
> > > -PE = "1"
> > > -
> > > -XORG_PN = "libXpm"
> > > -
> > > -PACKAGES =+ "sxpm cxpm"
> > > -FILES_cxpm = "${bindir}/cxpm"
> > > -FILES_sxpm = "${bindir}/sxpm"
> > > diff --git a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb b/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> > > deleted file mode 100644
> > > index 5d05a437a4..0000000000
> > > --- a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
> > > +++ /dev/null
> > > @@ -1,15 +0,0 @@
> > > -DESCRIPTION = "Tools for managing memory technology devices."
> > > -SECTION = "base"
> > > -DEPENDS = "zlib"
> > > -HOMEPAGE = "https://urldefense.proofpoint.com/v2/url?u=http-3A__www.linux-2Dmtd.infradead.org_&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=eyb4BYFT9E-HdgVPGQm8pJMdNlXGefc8FzxjWoAmrcs&s=rDxXZI7Evhz9_J8vJmFmp7sfSRycLIHpvHm2-rhxYYQ&e= "
> > > -LICENSE = "GPLv2"
> > > -LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
> > > -                    file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"
> > > -
> > > -SRC_URI = "https://urldefense.proofpoint.com/v2/url?u=ftp-3A__ftp.infradead.org_pub_mtd-2Dutils_mtd-2Dutils-2D-24-257BPV-257D.tar.gz&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=eyb4BYFT9E-HdgVPGQm8pJMdNlXGefc8FzxjWoAmrcs&s=iW6rRvnv1zLX6sYtZjtYVLji9LdaUjp64SzvLGJhKC0&e= "
> > > -
> > > -CFLAGS_prepend = "-I ${S}/include "
> > > -
> > > -do_install() {
> > > -	oe_runmake install DESTDIR=${D}
> > > -}
> > > 
> > 
> > This is probably a controversial commit. Rather than asking a question,
> > I preferred to send a patch.
> > 
> > Apparently, you were the last one to touch these files, so don't
> > hesitate to stop me and let us know why we should keep these files.
> > Maybe to make sure that our examples still compile? However, I found at
> > least one file that is not in sync with the contents of the documentation.
> > 
> 
> I wouldn't remove them as I find example recipes to be very welcomed as
> real life examples of what can/needs to be done. It shows also some
> gotchas and what a minimal recipe should look like.
> 
> What I have to complain about those files currently is that they are not
> built and they weren't working for a while, which is a bit of a shame
> for example recipes :)
> 
> I don't think keeping them in the yocto-docs is something we want to
> push for (at least I won't), but I feel like we should keep them
> somewhere they are built so we maintain them along other recipes.
> 
> I can see that we have a recipe for an out-of-tree kernel drievr recipe
> available in poky/meta-skeleton layer (called hello-mod). I guess this
> is a place we could put the examples you want to remove from yocto-docs?

If they were in meta-skeleton we could build/test them...

Cheers,

Richard


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
  2021-07-27 11:38     ` Richard Purdie
@ 2021-07-27 12:36       ` Michael Opdenacker
       [not found]       ` <1695A60376DC3ECA.18160@lists.yoctoproject.org>
  1 sibling, 0 replies; 9+ messages in thread
From: Michael Opdenacker @ 2021-07-27 12:36 UTC (permalink / raw)
  To: Richard Purdie, Quentin Schulz; +Cc: docs, Quentin Schulz

Richard, Quentin,

Many thanks for your feedback.

On 7/27/21 1:38 PM, Richard Purdie wrote:
> On Tue, 2021-07-27 at 13:23 +0200, Quentin Schulz wrote:
>> I wouldn't remove them as I find example recipes to be very welcomed as
>> real life examples of what can/needs to be done. It shows also some
>> gotchas and what a minimal recipe should look like.
>>
>> What I have to complain about those files currently is that they are not
>> built and they weren't working for a while, which is a bit of a shame
>> for example recipes :)
>>
>> I don't think keeping them in the yocto-docs is something we want to
>> push for (at least I won't), but I feel like we should keep them
>> somewhere they are built so we maintain them along other recipes.
>>
>> I can see that we have a recipe for an out-of-tree kernel drievr recipe
>> available in poky/meta-skeleton layer (called hello-mod). I guess this
>> is a place we could put the examples you want to remove from yocto-docs?
> If they were in meta-skeleton we could build/test them...


Thanks for the suggestion! I'll propose a patch doing this.

Cheers,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
       [not found]       ` <1695A60376DC3ECA.18160@lists.yoctoproject.org>
@ 2021-07-28 13:56         ` Michael Opdenacker
  2021-07-29 13:48           ` Richard Purdie
       [not found]         ` <1695F8F487052006.29235@lists.yoctoproject.org>
  1 sibling, 1 reply; 9+ messages in thread
From: Michael Opdenacker @ 2021-07-28 13:56 UTC (permalink / raw)
  To: Richard Purdie, Quentin Schulz; +Cc: docs, Quentin Schulz

Richard, Quentin, Nicolas and others,

On 7/27/21 2:36 PM, Michael Opdenacker wrote:
> Richard, Quentin,
>
> Many thanks for your feedback.
>
> On 7/27/21 1:38 PM, Richard Purdie wrote:
>> On Tue, 2021-07-27 at 13:23 +0200, Quentin Schulz wrote:
>>> I wouldn't remove them as I find example recipes to be very welcomed as
>>> real life examples of what can/needs to be done. It shows also some
>>> gotchas and what a minimal recipe should look like.
>>>
>>> What I have to complain about those files currently is that they are not
>>> built and they weren't working for a while, which is a bit of a shame
>>> for example recipes :)
>>>
>>> I don't think keeping them in the yocto-docs is something we want to
>>> push for (at least I won't), but I feel like we should keep them
>>> somewhere they are built so we maintain them along other recipes.
>>>
>>> I can see that we have a recipe for an out-of-tree kernel drievr recipe
>>> available in poky/meta-skeleton layer (called hello-mod). I guess this
>>> is a place we could put the examples you want to remove from yocto-docs?
>> If they were in meta-skeleton we could build/test them...
>
> Thanks for the suggestion! I'll propose a patch doing this.

While I had no problem moving and testing the "hello-single",
"hello-autotools"  (GNU hello actually) and "libxpm" recipe examples,
I'm struggling with the "mtd-utils" one.

Neither the example recipe (version 1.0.0:
http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb)
nor the one which source code is directly in the documentation (version
1.5.1+:
http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/dev-manual/common-tasks.rst#n2307)
compile any more.

Given that we have an upstream mtd-utils recipe that works, what's the
point of trying to fix a broken example? This seems like a waste of
effort to me...

So, may I drop that old mtd-utils example?

Thanks in advance for your advice.
Michael.
-- 

Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
       [not found]         ` <1695F8F487052006.29235@lists.yoctoproject.org>
@ 2021-07-29 13:39           ` Michael Opdenacker
  0 siblings, 0 replies; 9+ messages in thread
From: Michael Opdenacker @ 2021-07-29 13:39 UTC (permalink / raw)
  To: Richard Purdie, Quentin Schulz; +Cc: docs, Quentin Schulz

Greetings,

On 7/28/21 3:56 PM, Michael Opdenacker wrote:
> While I had no problem moving and testing the "hello-single",
> "hello-autotools"  (GNU hello actually) and "libxpm" recipe examples,
> I'm struggling with the "mtd-utils" one.
>
> Neither the example recipe (version 1.0.0:
> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb)
> nor the one which source code is directly in the documentation (version
> 1.5.1+:
> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/dev-manual/common-tasks.rst#n2307)
> compile any more.
>
> Given that we have an upstream mtd-utils recipe that works, what's the
> point of trying to fix a broken example? This seems like a waste of
> effort to me...
>
> So, may I drop that old mtd-utils example?


Following this thread, I posted a patch for OE-core to add the 3
examples that are still working fine:
https://lists.openembedded.org/g/openembedded-core/message/154245

I'll remove the files from the documentation (including the broken
"mtd-utils" one) once this patch is accepted.

Cheers,
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
  2021-07-28 13:56         ` Michael Opdenacker
@ 2021-07-29 13:48           ` Richard Purdie
  2021-07-30 16:41             ` Michael Opdenacker
       [not found]             ` <16969F1E09D6E656.27324@lists.yoctoproject.org>
  0 siblings, 2 replies; 9+ messages in thread
From: Richard Purdie @ 2021-07-29 13:48 UTC (permalink / raw)
  To: Michael Opdenacker, Quentin Schulz; +Cc: docs, Quentin Schulz

On Wed, 2021-07-28 at 15:56 +0200, Michael Opdenacker wrote:
> Richard, Quentin, Nicolas and others,
> 
> On 7/27/21 2:36 PM, Michael Opdenacker wrote:
> > Richard, Quentin,
> > 
> > Many thanks for your feedback.
> > 
> > On 7/27/21 1:38 PM, Richard Purdie wrote:
> > > On Tue, 2021-07-27 at 13:23 +0200, Quentin Schulz wrote:
> > > > I wouldn't remove them as I find example recipes to be very welcomed as
> > > > real life examples of what can/needs to be done. It shows also some
> > > > gotchas and what a minimal recipe should look like.
> > > > 
> > > > What I have to complain about those files currently is that they are not
> > > > built and they weren't working for a while, which is a bit of a shame
> > > > for example recipes :)
> > > > 
> > > > I don't think keeping them in the yocto-docs is something we want to
> > > > push for (at least I won't), but I feel like we should keep them
> > > > somewhere they are built so we maintain them along other recipes.
> > > > 
> > > > I can see that we have a recipe for an out-of-tree kernel drievr recipe
> > > > available in poky/meta-skeleton layer (called hello-mod). I guess this
> > > > is a place we could put the examples you want to remove from yocto-docs?
> > > If they were in meta-skeleton we could build/test them...
> > 
> > Thanks for the suggestion! I'll propose a patch doing this.
> 
> While I had no problem moving and testing the "hello-single",
> "hello-autotools"  (GNU hello actually) and "libxpm" recipe examples,
> I'm struggling with the "mtd-utils" one.
> 
> Neither the example recipe (version 1.0.0:
> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb)
> nor the one which source code is directly in the documentation (version
> 1.5.1+:
> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/dev-manual/common-tasks.rst#n2307)
> compile any more.
> 
> Given that we have an upstream mtd-utils recipe that works, what's the
> point of trying to fix a broken example? This seems like a waste of
> effort to me...
> 
> So, may I drop that old mtd-utils example?

I'd say yes, that one isn't adding value.

Cheers,

Richard


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
  2021-07-29 13:48           ` Richard Purdie
@ 2021-07-30 16:41             ` Michael Opdenacker
       [not found]             ` <16969F1E09D6E656.27324@lists.yoctoproject.org>
  1 sibling, 0 replies; 9+ messages in thread
From: Michael Opdenacker @ 2021-07-30 16:41 UTC (permalink / raw)
  To: Richard Purdie, Quentin Schulz; +Cc: docs, Quentin Schulz

Hi Richard,

On 7/29/21 3:48 PM, Richard Purdie wrote:
>
>> While I had no problem moving and testing the "hello-single",
>> "hello-autotools"  (GNU hello actually) and "libxpm" recipe examples,
>> I'm struggling with the "mtd-utils" one.
>>
>> Neither the example recipe (version 1.0.0:
>> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb)
>> nor the one which source code is directly in the documentation (version
>> 1.5.1+:
>> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/dev-manual/common-tasks.rst#n2307)
>> compile any more.
>>
>> Given that we have an upstream mtd-utils recipe that works, what's the
>> point of trying to fix a broken example? This seems like a waste of
>> effort to me...
>>
>> So, may I drop that old mtd-utils example?
> I'd say yes, that one isn't adding value.

Thanks for confirming this.

I'm waiting for you to merge my oe-core patch
(https://lists.openembedded.org/g/openembedded-core/message/154245) to
remove these examples from the documentation.

Thank you in advance,
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [docs] [PATCH] ref-manual: remove unused example recipe source files
       [not found]             ` <16969F1E09D6E656.27324@lists.yoctoproject.org>
@ 2021-08-02 16:16               ` Michael Opdenacker
  0 siblings, 0 replies; 9+ messages in thread
From: Michael Opdenacker @ 2021-08-02 16:16 UTC (permalink / raw)
  To: Richard Purdie, Quentin Schulz; +Cc: docs, Quentin Schulz


On 7/30/21 6:41 PM, Michael Opdenacker wrote:
> Hi Richard,
>
> On 7/29/21 3:48 PM, Richard Purdie wrote:
>>> While I had no problem moving and testing the "hello-single",
>>> "hello-autotools"  (GNU hello actually) and "libxpm" recipe examples,
>>> I'm struggling with the "mtd-utils" one.
>>>
>>> Neither the example recipe (version 1.0.0:
>>> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb)
>>> nor the one which source code is directly in the documentation (version
>>> 1.5.1+:
>>> http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/dev-manual/common-tasks.rst#n2307)
>>> compile any more.
>>>
>>> Given that we have an upstream mtd-utils recipe that works, what's the
>>> point of trying to fix a broken example? This seems like a waste of
>>> effort to me...
>>>
>>> So, may I drop that old mtd-utils example?
>> I'd say yes, that one isn't adding value.
> Thanks for confirming this.
>
> I'm waiting for you to merge my oe-core patch
> (https://lists.openembedded.org/g/openembedded-core/message/154245) to
> remove these examples from the documentation.


This is done now (thanks Richard!).
The description of this change has been updated and the commit is in
master-next now.

Cheers,
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2021-08-02 16:16 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <16959EEB5BD85597.12821@lists.yoctoproject.org>
2021-07-27 10:29 ` [docs] [PATCH] ref-manual: remove unused example recipe source files Michael Opdenacker
2021-07-27 11:23   ` Quentin Schulz
2021-07-27 11:38     ` Richard Purdie
2021-07-27 12:36       ` Michael Opdenacker
     [not found]       ` <1695A60376DC3ECA.18160@lists.yoctoproject.org>
2021-07-28 13:56         ` Michael Opdenacker
2021-07-29 13:48           ` Richard Purdie
2021-07-30 16:41             ` Michael Opdenacker
     [not found]             ` <16969F1E09D6E656.27324@lists.yoctoproject.org>
2021-08-02 16:16               ` Michael Opdenacker
     [not found]         ` <1695F8F487052006.29235@lists.yoctoproject.org>
2021-07-29 13:39           ` Michael Opdenacker

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.