[DISCUSSION] Directory structure of isar repo

[DISCUSSION] Directory structure of isar repo

[Claudius Heine]

Hi,

since the last discussion about the directory structure went a bit stale 
I wanted to restart it here and present my suggestion.

Here is a mockup of a subset of the directory tree how I would try to 
improve it. I will leave some comments about my reasons in the next mail.

Cheers,
Claudius

.
├── meta-isar
│   ├── classes
│   │   ├── base.bbclass
│   │   ├── dpkg-base.bbclass
│   │   ├── dpkg.bbclass
│   │   ├── dpkg-raw.bbclass
│   │   ├── ext4-img.bbclass
│   │   ├── image.bbclass
│   │   ├── isar-bootstrap-helper.bbclass
│   │   ├── isar-events.bbclass
│   │   └── patch.bbclass
│   ├── conf
│   │   ├── isar-bitbake.conf
│   │   └── layer.conf
│   ├── lib
│   │   └── oe
│   │       └── path.py
│   ├── licenses
│   │   ├── COPYING.GPLv2
│   │   └── COPYING.MIT
│   ├── recipes-core
│   │   ├── images
│   │   │   ├── isar-image-base.bb
│   │   │   └── isar-image-debug.bb
│   │   └── isar-bootstrap
│   │       ├── files
│   │       │   └── isar-apt.conf
│   │       └── isar-bootstrap.bb
│   ├── recipes-devtools
│   │   ├── buildchroot
│   │   │   ├── buildchroot.bb
│   │   │   └── files
│   │   │       ├── build.sh
│   │   │       └── configscript.sh
│   │   └── isar-apt
│   │       ├── files
│   │       │   └── distributions.in
│   │       └── isar-apt.bb
│   └── recipes-kernel
│       ├── linux
│       │   ├── files
│       │   │   └── build-kernel.sh
│       │   ├── linux-custom.inc
│       │   └── linux-distro.bb
│       └── linux-module
│           ├── files
│           │   └── debian
│           │       ├── changelog
│           │       ├── compat
│           │       ├── control
│           │       └── rules
│           └── module.inc
├── meta-isar-debian
│   ├── conf
│   │   ├── bblayers.conf.sample
│   │   ├── distro
│   │   │   ├── debian-jessie.conf
│   │   │   ├── debian-jessie.list
│   │   │   ├── debian-stretch.conf
│   │   │   ├── debian-stretch.list
│   │   │   ├── debian-wheezy.conf
│   │   │   └── debian-wheezy.list
│   │   ├── layer.conf
│   │   ├── local.conf.sample
│   │   ├── machine
│   │   │   ├── qemuamd64.conf
│   │   │   ├── qemuarm64.conf
│   │   │   ├── qemuarm.conf
│   │   │   └── qemui386.conf
│   │   └── multiconfig
│   │       ├── qemuamd64-jessie.conf
│   │       ├── qemuamd64-stretch.conf
│   │       ├── qemuarm64-stretch.conf
│   │       ├── qemuarm-jessie.conf
│   │       ├── qemuarm-stretch.conf
│   │       ├── qemuarm-wheezy.conf
│   │       ├── qemui386-jessie.conf
│   │       └── qemui386-stretch.conf
│   └── recipes-core
│       └── images
│           ├── files
│           │   └── debian-configscript.sh
│           └── isar-image-base.bbappend
├── meta-isar-example
│   ├── classes
│   │   └── rpi-sdimg.bbclass
│   ├── conf
│   │   ├── distro
│   │   │   ├── raspbian-jessie.conf
│   │   │   └── raspbian-jessie.list
│   │   ├── layer.conf
│   │   ├── machine
│   │   │   └── rpi.conf
│   │   └── multiconfig
│   │       └── rpi-jessie.conf
│   ├── recipes-app
│   │   ├── example-hello
│   │   │   ├── example-hello.bb
│   │   │   └── files
│   │   │       ├── 0001-Add-some-help.patch
│   │   │       └── yet-another-change.txt
│   │   ├── example-raw
│   │   │   ├── example-raw_0.2.bb
│   │   │   └── files
│   │   │       ├── postinst
│   │   │       └── README
│   │   └── libhello
│   │       └── libhello.bb
│   ├── recipes-core
│   │   └── images
│   │       ├── files
│   │       │   └── raspbian-configscript.sh
│   │       └── isar-image-base.bbappend
│   ├── recipes-kernel
│   │   ├── example-module
│   │   │   ├── example-module.bb
│   │   │   └── files
│   │   │       └── src
│   │   │           ├── example-module.c
│   │   │           └── Makefile
│   │   └── linux
│   │       ├── files
│   │       │   └── x86_64_defconfig
│   │       ├── linux-cip_4.4.bb
│   │       └── linux-mainline_4.14.18.bb
│   └── scripts
│       └── lib
│           └── wic
│               └── canned-wks
│                   └── sdimage-efi.wks
...


-- 
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-54 Fax: (+49)-8142-66989-80 Email: ch@denx.de

Re: [DISCUSSION] Directory structure of isar repo

[Jan Kiszka]

On 2018-04-17 12:57, [ext] Claudius Heine wrote:
> Hi,
> 
> since the last discussion about the directory structure went a bit stale
> I wanted to restart it here and present my suggestion.
> 
> Here is a mockup of a subset of the directory tree how I would try to
> improve it. I will leave some comments about my reasons in the next mail.
> 
> Cheers,
> Claudius
> 
> .
> ├── meta-isar
> │   ├── classes
> │   │   ├── base.bbclass
> │   │   ├── dpkg-base.bbclass
> │   │   ├── dpkg.bbclass
> │   │   ├── dpkg-raw.bbclass
> │   │   ├── ext4-img.bbclass
> │   │   ├── image.bbclass
> │   │   ├── isar-bootstrap-helper.bbclass
> │   │   ├── isar-events.bbclass
> │   │   └── patch.bbclass
> │   ├── conf
> │   │   ├── isar-bitbake.conf
> │   │   └── layer.conf
> │   ├── lib
> │   │   └── oe
> │   │       └── path.py
> │   ├── licenses
> │   │   ├── COPYING.GPLv2
> │   │   └── COPYING.MIT
> │   ├── recipes-core
> │   │   ├── images
> │   │   │   ├── isar-image-base.bb
> │   │   │   └── isar-image-debug.bb
> │   │   └── isar-bootstrap
> │   │       ├── files
> │   │       │   └── isar-apt.conf
> │   │       └── isar-bootstrap.bb
> │   ├── recipes-devtools
> │   │   ├── buildchroot
> │   │   │   ├── buildchroot.bb
> │   │   │   └── files
> │   │   │       ├── build.sh
> │   │   │       └── configscript.sh
> │   │   └── isar-apt
> │   │       ├── files
> │   │       │   └── distributions.in
> │   │       └── isar-apt.bb
> │   └── recipes-kernel
> │       ├── linux
> │       │   ├── files
> │       │   │   └── build-kernel.sh
> │       │   ├── linux-custom.inc
> │       │   └── linux-distro.bb
> │       └── linux-module
> │           ├── files
> │           │   └── debian
> │           │       ├── changelog
> │           │       ├── compat
> │           │       ├── control
> │           │       └── rules
> │           └── module.inc
> ├── meta-isar-debian
> │   ├── conf
> │   │   ├── bblayers.conf.sample
> │   │   ├── distro
> │   │   │   ├── debian-jessie.conf
> │   │   │   ├── debian-jessie.list
> │   │   │   ├── debian-stretch.conf
> │   │   │   ├── debian-stretch.list
> │   │   │   ├── debian-wheezy.conf
> │   │   │   └── debian-wheezy.list
> │   │   ├── layer.conf
> │   │   ├── local.conf.sample
> │   │   ├── machine
> │   │   │   ├── qemuamd64.conf
> │   │   │   ├── qemuarm64.conf
> │   │   │   ├── qemuarm.conf
> │   │   │   └── qemui386.conf
> │   │   └── multiconfig
> │   │       ├── qemuamd64-jessie.conf
> │   │       ├── qemuamd64-stretch.conf
> │   │       ├── qemuarm64-stretch.conf
> │   │       ├── qemuarm-jessie.conf
> │   │       ├── qemuarm-stretch.conf
> │   │       ├── qemuarm-wheezy.conf
> │   │       ├── qemui386-jessie.conf
> │   │       └── qemui386-stretch.conf
> │   └── recipes-core
> │       └── images
> │           ├── files
> │           │   └── debian-configscript.sh
> │           └── isar-image-base.bbappend
> ├── meta-isar-example
> │   ├── classes
> │   │   └── rpi-sdimg.bbclass
> │   ├── conf
> │   │   ├── distro
> │   │   │   ├── raspbian-jessie.conf
> │   │   │   └── raspbian-jessie.list

> │   │   ├── layer.conf
> │   │   ├── machine
> │   │   │   └── rpi.conf
> │   │   └── multiconfig
> │   │       └── rpi-jessie.conf

Raspbian stuff should go into meta-isar-raspbian or meta-isar directly
(see below).

> │   ├── recipes-app
> │   │   ├── example-hello
> │   │   │   ├── example-hello.bb
> │   │   │   └── files
> │   │   │       ├── 0001-Add-some-help.patch
> │   │   │       └── yet-another-change.txt
> │   │   ├── example-raw
> │   │   │   ├── example-raw_0.2.bb
> │   │   │   └── files
> │   │   │       ├── postinst
> │   │   │       └── README
> │   │   └── libhello
> │   │       └── libhello.bb
> │   ├── recipes-core
> │   │   └── images
> │   │       ├── files
> │   │       │   └── raspbian-configscript.sh
> │   │       └── isar-image-base.bbappend
> │   ├── recipes-kernel
> │   │   ├── example-module
> │   │   │   ├── example-module.bb
> │   │   │   └── files
> │   │   │       └── src
> │   │   │           ├── example-module.c
> │   │   │           └── Makefile
> │   │   └── linux
> │   │       ├── files
> │   │       │   └── x86_64_defconfig
> │   │       ├── linux-cip_4.4.bb
> │   │       └── linux-mainline_4.14.18.bb
> │   └── scripts
> │       └── lib
> │           └── wic
> │               └── canned-wks
> │                   └── sdimage-efi.wks
> ...
> 
> 

I'm not sure if a split-up into meta-isar-{debian,raspbian} is already
needed at this point. Otherwise, this refactoring looks good and would
be welcome.

Jan

-- 
Siemens AG, Corporate Technology, CT RDA IOT SES-DE
Corporate Competence Center Embedded Linux

Re: [DISCUSSION] Directory structure of isar repo

[Claudius Heine]

Hi Jan,

On 2018-04-17 13:49, Jan Kiszka wrote:
> On 2018-04-17 12:57, [ext] Claudius Heine wrote:
>> Hi,
>>
>> since the last discussion about the directory structure went a bit stale
>> I wanted to restart it here and present my suggestion.
>>
>> Here is a mockup of a subset of the directory tree how I would try to
>> improve it. I will leave some comments about my reasons in the next mail.
>>
>> Cheers,
>> Claudius
>>
>> .
>> ├── meta-isar
>> │   ├── classes
>> │   │   ├── base.bbclass
>> │   │   ├── dpkg-base.bbclass
>> │   │   ├── dpkg.bbclass
>> │   │   ├── dpkg-raw.bbclass
>> │   │   ├── ext4-img.bbclass
>> │   │   ├── image.bbclass
>> │   │   ├── isar-bootstrap-helper.bbclass
>> │   │   ├── isar-events.bbclass
>> │   │   └── patch.bbclass
>> │   ├── conf
>> │   │   ├── isar-bitbake.conf
>> │   │   └── layer.conf
>> │   ├── lib
>> │   │   └── oe
>> │   │       └── path.py
>> │   ├── licenses
>> │   │   ├── COPYING.GPLv2
>> │   │   └── COPYING.MIT
>> │   ├── recipes-core
>> │   │   ├── images
>> │   │   │   ├── isar-image-base.bb
>> │   │   │   └── isar-image-debug.bb
>> │   │   └── isar-bootstrap
>> │   │       ├── files
>> │   │       │   └── isar-apt.conf
>> │   │       └── isar-bootstrap.bb
>> │   ├── recipes-devtools
>> │   │   ├── buildchroot
>> │   │   │   ├── buildchroot.bb
>> │   │   │   └── files
>> │   │   │       ├── build.sh
>> │   │   │       └── configscript.sh
>> │   │   └── isar-apt
>> │   │       ├── files
>> │   │       │   └── distributions.in
>> │   │       └── isar-apt.bb
>> │   └── recipes-kernel
>> │       ├── linux
>> │       │   ├── files
>> │       │   │   └── build-kernel.sh
>> │       │   ├── linux-custom.inc
>> │       │   └── linux-distro.bb
>> │       └── linux-module
>> │           ├── files
>> │           │   └── debian
>> │           │       ├── changelog
>> │           │       ├── compat
>> │           │       ├── control
>> │           │       └── rules
>> │           └── module.inc
>> ├── meta-isar-debian
>> │   ├── conf
>> │   │   ├── bblayers.conf.sample
>> │   │   ├── distro
>> │   │   │   ├── debian-jessie.conf
>> │   │   │   ├── debian-jessie.list
>> │   │   │   ├── debian-stretch.conf
>> │   │   │   ├── debian-stretch.list
>> │   │   │   ├── debian-wheezy.conf
>> │   │   │   └── debian-wheezy.list
>> │   │   ├── layer.conf
>> │   │   ├── local.conf.sample
>> │   │   ├── machine
>> │   │   │   ├── qemuamd64.conf
>> │   │   │   ├── qemuarm64.conf
>> │   │   │   ├── qemuarm.conf
>> │   │   │   └── qemui386.conf
>> │   │   └── multiconfig
>> │   │       ├── qemuamd64-jessie.conf
>> │   │       ├── qemuamd64-stretch.conf
>> │   │       ├── qemuarm64-stretch.conf
>> │   │       ├── qemuarm-jessie.conf
>> │   │       ├── qemuarm-stretch.conf
>> │   │       ├── qemuarm-wheezy.conf
>> │   │       ├── qemui386-jessie.conf
>> │   │       └── qemui386-stretch.conf
>> │   └── recipes-core
>> │       └── images
>> │           ├── files
>> │           │   └── debian-configscript.sh
>> │           └── isar-image-base.bbappend
>> ├── meta-isar-example
>> │   ├── classes
>> │   │   └── rpi-sdimg.bbclass
>> │   ├── conf
>> │   │   ├── distro
>> │   │   │   ├── raspbian-jessie.conf
>> │   │   │   └── raspbian-jessie.list
> 
>> │   │   ├── layer.conf
>> │   │   ├── machine
>> │   │   │   └── rpi.conf
>> │   │   └── multiconfig
>> │   │       └── rpi-jessie.conf
> 
> Raspbian stuff should go into meta-isar-raspbian or meta-isar directly
> (see below).

Why? My reasons for not doing that are in my reply to this post:

----
All real example code I moved there as well as the raspbian 
configuration. I moved the raspbian configuration here for a couple of 
reasons:

   - Its a good example how to customize Isar to use a different repo 
and create a bsp.
   - While Isar supports raspbian, that support is currently not very 
well maintained. We only support RPi1 AFAIK. Its better if someone more 
interested in maintaining this port does it IMO.
----

While I see debian being actively used I don't know how many active 
developers are using it for raspbian images. I would say that a 
separated 'meta-isar-raspbian' meta layer that only supports the jessie 
version of it would be a bit underwhelming. But as part of the example 
that is enough.

Of course if someone steps up and improves the maintenance of raspbian, 
then having such a meta-isar-raspbian layer would be ok.

> 
>> │   ├── recipes-app
>> │   │   ├── example-hello
>> │   │   │   ├── example-hello.bb
>> │   │   │   └── files
>> │   │   │       ├── 0001-Add-some-help.patch
>> │   │   │       └── yet-another-change.txt
>> │   │   ├── example-raw
>> │   │   │   ├── example-raw_0.2.bb
>> │   │   │   └── files
>> │   │   │       ├── postinst
>> │   │   │       └── README
>> │   │   └── libhello
>> │   │       └── libhello.bb
>> │   ├── recipes-core
>> │   │   └── images
>> │   │       ├── files
>> │   │       │   └── raspbian-configscript.sh
>> │   │       └── isar-image-base.bbappend
>> │   ├── recipes-kernel
>> │   │   ├── example-module
>> │   │   │   ├── example-module.bb
>> │   │   │   └── files
>> │   │   │       └── src
>> │   │   │           ├── example-module.c
>> │   │   │           └── Makefile
>> │   │   └── linux
>> │   │       ├── files
>> │   │       │   └── x86_64_defconfig
>> │   │       ├── linux-cip_4.4.bb
>> │   │       └── linux-mainline_4.14.18.bb
>> │   └── scripts
>> │       └── lib
>> │           └── wic
>> │               └── canned-wks
>> │                   └── sdimage-efi.wks
>> ...
>>
>>
> 
> I'm not sure if a split-up into meta-isar-{debian,raspbian} is already
> needed at this point.

Thats a fair point. We could put the support of debian into meta-isar as 
well. I split it in my draft here, because splitting the distribution 
support from the core was the intention of current directory layout.

> Otherwise, this refactoring looks good and would
> be welcome.

Thanks!

Before we submit patches. We should have some sort of shared vision 
where we want to go.

Cheers,
Claudius

-- 
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-54 Fax: (+49)-8142-66989-80 Email: ch@denx.de

Re: [DISCUSSION] Directory structure of isar repo

[Claudius Heine]

Hi again,

as promised, here are my reasons choosing this structure:

On 2018-04-17 11:22, Claudius Heine wrote:
> 
> .
> ├── meta-isar

meta-isar is in principle the old 'meta' directory. I did this because I 
think pushing 'meta-isar' as a general prefix to all meta layers related 
to isar makes it easier to distinguish them from OE meta layers. This 
makes it also easier to find other public isar metalayers.

> │   ├── classes
> │   │   ├── base.bbclass
> │   │   ├── dpkg-base.bbclass
> │   │   ├── dpkg.bbclass
> │   │   ├── dpkg-raw.bbclass
> │   │   ├── ext4-img.bbclass
> │   │   ├── image.bbclass
> │   │   ├── isar-bootstrap-helper.bbclass
> │   │   ├── isar-events.bbclass
> │   │   └── patch.bbclass
> │   ├── conf
> │   │   ├── isar-bitbake.conf
> │   │   └── layer.conf
> │   ├── lib
> │   │   └── oe
> │   │       └── path.py
> │   ├── licenses
> │   │   ├── COPYING.GPLv2
> │   │   └── COPYING.MIT > │   ├── recipes-core
> │   │   ├── images
> │   │   │   ├── isar-image-base.bb
> │   │   │   └── isar-image-debug.bb

I added the isar-image-base to the old 'meta' now 'meta-isar' directory, 
because it pretty much mostly used as the 'core-image-minimal' of OE, 
and that is part of its main layer.

> │   │   └── isar-bootstrap
> │   │       ├── files
> │   │       │   └── isar-apt.conf
> │   │       └── isar-bootstrap.bb
> │   ├── recipes-devtools
> │   │   ├── buildchroot
> │   │   │   ├── buildchroot.bb
> │   │   │   └── files
> │   │   │       ├── build.sh
> │   │   │       └── configscript.sh
> │   │   └── isar-apt
> │   │       ├── files
> │   │       │   └── distributions.in
> │   │       └── isar-apt.bb
> │   └── recipes-kernel
> │       ├── linux
> │       │   ├── files
> │       │   │   └── build-kernel.sh
> │       │   ├── linux-custom.inc
> │       │   └── linux-distro.bb
> │       └── linux-module
> │           ├── files
> │           │   └── debian
> │           │       ├── changelog
> │           │       ├── compat
> │           │       ├── control
> │           │       └── rules
> │           └── module.inc
> ├── meta-isar-debian

'meta-isar-debian' contains all the files and configuration for the 
mainline debian distribution. Maybe it makes even sense to include this 
to 'meta-isar' since Debian is the mainline. Other meta-layers at a 
similar level could be 'meta-isar-ubuntu' or 'meta-isar-raspbian'.

> │   ├── conf
> │   │   ├── bblayers.conf.sample
> │   │   ├── distro
> │   │   │   ├── debian-jessie.conf
> │   │   │   ├── debian-jessie.list
> │   │   │   ├── debian-stretch.conf
> │   │   │   ├── debian-stretch.list
> │   │   │   ├── debian-wheezy.conf
> │   │   │   └── debian-wheezy.list
> │   │   ├── layer.conf
> │   │   ├── local.conf.sample
> │   │   ├── machine
> │   │   │   ├── qemuamd64.conf
> │   │   │   ├── qemuarm64.conf
> │   │   │   ├── qemuarm.conf
> │   │   │   └── qemui386.conf
> │   │   └── multiconfig
> │   │       ├── qemuamd64-jessie.conf
> │   │       ├── qemuamd64-stretch.conf
> │   │       ├── qemuarm64-stretch.conf
> │   │       ├── qemuarm-jessie.conf
> │   │       ├── qemuarm-stretch.conf
> │   │       ├── qemuarm-wheezy.conf
> │   │       ├── qemui386-jessie.conf
> │   │       └── qemui386-stretch.conf
> │   └── recipes-core
> │       └── images
> │           ├── files
> │           │   └── debian-configscript.sh
> │           └── isar-image-base.bbappend
> ├── meta-isar-example

All real example code I moved there as well as the raspbian 
configuration. I moved the raspbian configuration here for a couple of 
reasons:

   - Its a good example how to customize Isar to use a different repo 
and create a bsp.
   - While Isar supports raspbian, that support is currently not very 
well maintained. We only support RPi1 AFAIK. Its better if someone more 
interested in maintaining this port does it IMO.

> │   ├── classes
> │   │   └── rpi-sdimg.bbclass
> │   ├── conf
> │   │   ├── distro
> │   │   │   ├── raspbian-jessie.conf
> │   │   │   └── raspbian-jessie.list
> │   │   ├── layer.conf
> │   │   ├── machine
> │   │   │   └── rpi.conf
> │   │   └── multiconfig
> │   │       └── rpi-jessie.conf
> │   ├── recipes-app
> │   │   ├── example-hello
> │   │   │   ├── example-hello.bb
> │   │   │   └── files
> │   │   │       ├── 0001-Add-some-help.patch
> │   │   │       └── yet-another-change.txt
> │   │   ├── example-raw
> │   │   │   ├── example-raw_0.2.bb
> │   │   │   └── files
> │   │   │       ├── postinst
> │   │   │       └── README
> │   │   └── libhello
> │   │       └── libhello.bb
> │   ├── recipes-core
> │   │   └── images
> │   │       ├── files
> │   │       │   └── raspbian-configscript.sh
> │   │       └── isar-image-base.bbappend
> │   ├── recipes-kernel
> │   │   ├── example-module
> │   │   │   ├── example-module.bb
> │   │   │   └── files
> │   │   │       └── src
> │   │   │           ├── example-module.c
> │   │   │           └── Makefile
> │   │   └── linux
> │   │       ├── files
> │   │       │   └── x86_64_defconfig
> │   │       ├── linux-cip_4.4.bb
> │   │       └── linux-mainline_4.14.18.bb
> │   └── scripts
> │       └── lib
> │           └── wic
> │               └── canned-wks
> │                   └── sdimage-efi.wks
> ...
> 

Cheers,
Claudius

-- 
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-54 Fax: (+49)-8142-66989-80 Email: ch@denx.de