| Message ID | 77b2c035-7eec-2c34-e433-55d0e713234c@crashcourse.ca |
|---|---|
| State | New |
| Headers | show |
| Series | bsp-guide: shorten contents of meta-raspberrypi layer | expand |
Hi, On Tue Jun 17, 2025 at 11:52 AM CEST, Robert P. J. Day wrote: > > It seems overly verbose to list the entire contents of the > meta-raspberrypi layer, so this replaces all of that output with a > shortened version displaying only the more top-level directories, > which still gives the reader a good idea of the overall structure of a > BSP layer. > > If the reader wants more detail, they're free to check out the layer > itself. > > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> > > --- > > diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst > index 35972f172..97c9c1bf2 100644 > --- a/documentation/bsp-guide/bsp.rst > +++ b/documentation/bsp-guide/bsp.rst > @@ -288,163 +288,82 @@ individual BSPs could differ. :: > meta-bsp_root_name/recipes-graphics/* > meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend > > -Below is an example of the Raspberry Pi BSP layer that is available from > -the :yocto_git:`Source Repositories <>`: > +Below is the abbreviated content of the higher levels of the > +``meta-raspberrypi`` BSP layer that is available from the > +:yocto_git:`Source Repositories <>`: > > .. code-block:: none > > - meta-raspberrypi/COPYING.MIT > - meta-raspberrypi/README.md > - meta-raspberrypi/classes > - meta-raspberrypi/classes/sdcard_image-rpi.bbclass > - meta-raspberrypi/conf/ > - meta-raspberrypi/conf/layer.conf > - meta-raspberrypi/conf/machine/ > - meta-raspberrypi/conf/machine/raspberrypi-cm.conf > - meta-raspberrypi/conf/machine/raspberrypi-cm3.conf > - meta-raspberrypi/conf/machine/raspberrypi.conf > - meta-raspberrypi/conf/machine/raspberrypi0-wifi.conf > - meta-raspberrypi/conf/machine/raspberrypi0.conf > - meta-raspberrypi/conf/machine/raspberrypi2.conf > - meta-raspberrypi/conf/machine/raspberrypi3-64.conf > - meta-raspberrypi/conf/machine/raspberrypi3.conf > - meta-raspberrypi/conf/machine/include > - meta-raspberrypi/conf/machine/include/rpi-base.inc > - meta-raspberrypi/conf/machine/include/rpi-default-providers.inc > - meta-raspberrypi/conf/machine/include/rpi-default-settings.inc > - meta-raspberrypi/conf/machine/include/rpi-default-versions.inc > - meta-raspberrypi/conf/machine/include/tune-arm1176jzf-s.inc > - meta-raspberrypi/docs > - meta-raspberrypi/docs/Makefile > - meta-raspberrypi/docs/conf.py > - meta-raspberrypi/docs/contributing.md > - meta-raspberrypi/docs/extra-apps.md > - meta-raspberrypi/docs/extra-build-config.md > - meta-raspberrypi/docs/index.rst > - meta-raspberrypi/docs/layer-contents.md > - meta-raspberrypi/docs/readme.md > - meta-raspberrypi/files > - meta-raspberrypi/files/custom-licenses > - meta-raspberrypi/files/custom-licenses/Broadcom > - meta-raspberrypi/recipes-bsp > - meta-raspberrypi/recipes-bsp/bootfiles > - meta-raspberrypi/recipes-bsp/bootfiles/bcm2835-bootfiles.bb > - meta-raspberrypi/recipes-bsp/bootfiles/rpi-config_git.bb > - meta-raspberrypi/recipes-bsp/common > - meta-raspberrypi/recipes-bsp/common/firmware.inc > - meta-raspberrypi/recipes-bsp/formfactor > - meta-raspberrypi/recipes-bsp/formfactor/formfactor > - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi > - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi/machconfig > - meta-raspberrypi/recipes-bsp/formfactor/formfactor_%.bbappend > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files/boot.cmd.in > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/rpi-u-boot-scr.bb > - meta-raspberrypi/recipes-bsp/u-boot > - meta-raspberrypi/recipes-bsp/u-boot/u-boot > - meta-raspberrypi/recipes-bsp/u-boot/u-boot/*.patch > - meta-raspberrypi/recipes-bsp/u-boot/u-boot_%.bbappend > - meta-raspberrypi/recipes-connectivity > - meta-raspberrypi/recipes-connectivity/bluez5 > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5 > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/*.patch > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/BCM43430A1.hcd > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5brcm43438.service > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5_%.bbappend > - meta-raspberrypi/recipes-core > - meta-raspberrypi/recipes-core/images > - meta-raspberrypi/recipes-core/images/rpi-basic-image.bb > - meta-raspberrypi/recipes-core/images/rpi-hwup-image.bb > - meta-raspberrypi/recipes-core/images/rpi-test-image.bb > - meta-raspberrypi/recipes-core/packagegroups > - meta-raspberrypi/recipes-core/packagegroups/packagegroup-rpi-test.bb > - meta-raspberrypi/recipes-core/psplash > - meta-raspberrypi/recipes-core/psplash/files > - meta-raspberrypi/recipes-core/psplash/files/psplash-raspberrypi-img.h > - meta-raspberrypi/recipes-core/psplash/psplash_git.bbappend > - meta-raspberrypi/recipes-core/udev > - meta-raspberrypi/recipes-core/udev/udev-rules-rpi > - meta-raspberrypi/recipes-core/udev/udev-rules-rpi/99-com.rules > - meta-raspberrypi/recipes-core/udev/udev-rules-rpi.bb > - meta-raspberrypi/recipes-devtools > - meta-raspberrypi/recipes-devtools/bcm2835 > - meta-raspberrypi/recipes-devtools/bcm2835/bcm2835_1.52.bb > - meta-raspberrypi/recipes-devtools/pi-blaster > - meta-raspberrypi/recipes-devtools/pi-blaster/files > - meta-raspberrypi/recipes-devtools/pi-blaster/files/*.patch > - meta-raspberrypi/recipes-devtools/pi-blaster/pi-blaster_git.bb > - meta-raspberrypi/recipes-devtools/python > - meta-raspberrypi/recipes-devtools/python/python-rtimu > - meta-raspberrypi/recipes-devtools/python/python-rtimu/*.patch > - meta-raspberrypi/recipes-devtools/python/python-rtimu_git.bb > - meta-raspberrypi/recipes-devtools/python/python-sense-hat_2.2.0.bb > - meta-raspberrypi/recipes-devtools/python/rpi-gpio > - meta-raspberrypi/recipes-devtools/python/rpi-gpio/*.patch > - meta-raspberrypi/recipes-devtools/python/rpi-gpio_0.6.3.bb > - meta-raspberrypi/recipes-devtools/python/rpio > - meta-raspberrypi/recipes-devtools/python/rpio/*.patch > - meta-raspberrypi/recipes-devtools/python/rpio_0.10.0.bb > - meta-raspberrypi/recipes-devtools/wiringPi > - meta-raspberrypi/recipes-devtools/wiringPi/files > - meta-raspberrypi/recipes-devtools/wiringPi/files/*.patch > - meta-raspberrypi/recipes-devtools/wiringPi/wiringpi_git.bb > - meta-raspberrypi/recipes-graphics > - meta-raspberrypi/recipes-graphics/eglinfo > - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-fb_%.bbappend > - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-x11_%.bbappend > - meta-raspberrypi/recipes-graphics/mesa > - meta-raspberrypi/recipes-graphics/mesa/mesa-gl_%.bbappend > - meta-raspberrypi/recipes-graphics/mesa/mesa_%.bbappend > - meta-raspberrypi/recipes-graphics/userland > - meta-raspberrypi/recipes-graphics/userland/userland > - meta-raspberrypi/recipes-graphics/userland/userland/*.patch > - meta-raspberrypi/recipes-graphics/userland/userland_git.bb > - meta-raspberrypi/recipes-graphics/vc-graphics > - meta-raspberrypi/recipes-graphics/vc-graphics/files > - meta-raspberrypi/recipes-graphics/vc-graphics/files/egl.pc > - meta-raspberrypi/recipes-graphics/vc-graphics/files/vchiq.sh > - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics-hardfp.bb > - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.bb > - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.inc > - meta-raspberrypi/recipes-graphics/wayland > - meta-raspberrypi/recipes-graphics/wayland/weston_%.bbappend > - meta-raspberrypi/recipes-graphics/xorg-xserver > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/10-evdev.conf > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/98-pitft.conf > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/99-calibration.conf > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xorg_%.bbappend > - meta-raspberrypi/recipes-kernel > - meta-raspberrypi/recipes-kernel/linux-firmware > - meta-raspberrypi/recipes-kernel/linux-firmware/files > - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcmfmac43430-sdio.bin > - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcfmac43430-sdio.txt > - meta-raspberrypi/recipes-kernel/linux-firmware/linux-firmware_%.bbappend > - meta-raspberrypi/recipes-kernel/linux > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi-dev.bb > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi.inc > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.14.bb > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.9.bb > - meta-raspberrypi/recipes-multimedia > - meta-raspberrypi/recipes-multimedia/gstreamer > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx/*.patch > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx_%.bbappend > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-plugins-bad_%.bbappend > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12 > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12/*.patch > - meta-raspberrypi/recipes-multimedia/omxplayer > - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer > - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer/*.patch > - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer_git.bb > - meta-raspberrypi/recipes-multimedia/x264 > - meta-raspberrypi/recipes-multimedia/x264/x264_git.bbappend > - meta-raspberrypi/wic meta-raspberrypi/wic/sdimage-raspberrypi.wks > + ├── classes/ > + │ └── sdcard_image-rpi.bbclass > + ├── conf/ > + │ ├── layer.conf > + │ └── machine/ > + ├── COPYING.MIT > + ├── docs/ > + ├── dynamic-layers/ > + │ ├── meta-python/ > + │ ├── multimedia-layer/ > + │ ├── networking-layer/ > + │ ├── openembedded-layer/ > + │ └── qt5-layer/ > + ├── files/ > + │ └── custom-licenses/ > + ├── kas-poky-rpi.yml > + ├── lib/ > + │ └── oeqa/ > + ├── README.md > + ├── recipes-bsp/ > + │ ├── armstubs/ > + │ ├── bootfiles/ > + │ ├── common/ > + │ ├── formfactor/ > + │ ├── gpio-shutdown/ > + │ ├── rpi-eeprom/ > + │ ├── rpi-u-boot-scr/ > + │ └── u-boot/ > + ├── recipes-connectivity/ > + │ ├── bluez5/ > + │ └── pi-bluetooth/ > + ├── recipes-core/ > + │ ├── images/ > + │ ├── packagegroups/ > + │ ├── psplash/ > + │ └── udev/ > + ├── recipes-devtools/ > + │ ├── bcm2835/ > + │ ├── pi-blaster/ > + │ ├── python/ > + │ ├── raspi-gpio/ > + │ └── raspi-utils/ > + ├── recipes-graphics/ > + │ ├── cairo/ > + │ ├── kmscube/ > + │ ├── libsdl2/ > + │ ├── libva/ > + │ ├── mesa/ > + │ ├── piglit/ > + │ ├── raspidmx/ > + │ ├── userland/ > + │ ├── vc-graphics/ > + │ ├── wayland/ > + │ └── xorg-xserver/ > + ├── recipes-kernel/ > + │ ├── bluez-firmware-rpidistro/ > + │ ├── linux/ > + │ └── linux-firmware-rpidistro/ > + ├── recipes-multimedia/ > + │ ├── gstreamer/ > + │ ├── omxplayer/ > + │ ├── picamera-libs/ > + │ ├── python3-picamera/ > + │ ├── rpidistro-ffmpeg/ > + │ └── x264/ > + ├── recipes-sato/ > + │ └── libwpe_%.bbappend > + ├── SECURITY.md > + └── wic/ > + └── sdimage-raspberrypi.wks Code blocks need to be indented with three spaces (here two). I think it would be good to keep at least one directory showing the structure for a recipe (the bb file, a patch, etc), like python-rtimu in the previous code block for example. Thanks, Antonin
On Tue, 17 Jun 2025, Antonin Godard wrote: > Hi, > > On Tue Jun 17, 2025 at 11:52 AM CEST, Robert P. J. Day wrote: > > > > It seems overly verbose to list the entire contents of the > > meta-raspberrypi layer, so this replaces all of that output with a > > shortened version displaying only the more top-level directories, > > which still gives the reader a good idea of the overall structure of a > > BSP layer. > > > > If the reader wants more detail, they're free to check out the layer > > itself. > > > > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> > > > > --- > > > > diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst > > index 35972f172..97c9c1bf2 100644 > > --- a/documentation/bsp-guide/bsp.rst > > +++ b/documentation/bsp-guide/bsp.rst > > @@ -288,163 +288,82 @@ individual BSPs could differ. :: > > meta-bsp_root_name/recipes-graphics/* > > meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend > > > > -Below is an example of the Raspberry Pi BSP layer that is available from > > -the :yocto_git:`Source Repositories <>`: > > +Below is the abbreviated content of the higher levels of the > > +``meta-raspberrypi`` BSP layer that is available from the > > +:yocto_git:`Source Repositories <>`: > > > > .. code-block:: none > > > > - meta-raspberrypi/COPYING.MIT > > - meta-raspberrypi/README.md > > - meta-raspberrypi/classes > > - meta-raspberrypi/classes/sdcard_image-rpi.bbclass > > - meta-raspberrypi/conf/ > > - meta-raspberrypi/conf/layer.conf > > - meta-raspberrypi/conf/machine/ > > - meta-raspberrypi/conf/machine/raspberrypi-cm.conf > > - meta-raspberrypi/conf/machine/raspberrypi-cm3.conf > > - meta-raspberrypi/conf/machine/raspberrypi.conf > > - meta-raspberrypi/conf/machine/raspberrypi0-wifi.conf > > - meta-raspberrypi/conf/machine/raspberrypi0.conf > > - meta-raspberrypi/conf/machine/raspberrypi2.conf > > - meta-raspberrypi/conf/machine/raspberrypi3-64.conf > > - meta-raspberrypi/conf/machine/raspberrypi3.conf > > - meta-raspberrypi/conf/machine/include > > - meta-raspberrypi/conf/machine/include/rpi-base.inc > > - meta-raspberrypi/conf/machine/include/rpi-default-providers.inc > > - meta-raspberrypi/conf/machine/include/rpi-default-settings.inc > > - meta-raspberrypi/conf/machine/include/rpi-default-versions.inc > > - meta-raspberrypi/conf/machine/include/tune-arm1176jzf-s.inc > > - meta-raspberrypi/docs > > - meta-raspberrypi/docs/Makefile > > - meta-raspberrypi/docs/conf.py > > - meta-raspberrypi/docs/contributing.md > > - meta-raspberrypi/docs/extra-apps.md > > - meta-raspberrypi/docs/extra-build-config.md > > - meta-raspberrypi/docs/index.rst > > - meta-raspberrypi/docs/layer-contents.md > > - meta-raspberrypi/docs/readme.md > > - meta-raspberrypi/files > > - meta-raspberrypi/files/custom-licenses > > - meta-raspberrypi/files/custom-licenses/Broadcom > > - meta-raspberrypi/recipes-bsp > > - meta-raspberrypi/recipes-bsp/bootfiles > > - meta-raspberrypi/recipes-bsp/bootfiles/bcm2835-bootfiles.bb > > - meta-raspberrypi/recipes-bsp/bootfiles/rpi-config_git.bb > > - meta-raspberrypi/recipes-bsp/common > > - meta-raspberrypi/recipes-bsp/common/firmware.inc > > - meta-raspberrypi/recipes-bsp/formfactor > > - meta-raspberrypi/recipes-bsp/formfactor/formfactor > > - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi > > - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi/machconfig > > - meta-raspberrypi/recipes-bsp/formfactor/formfactor_%.bbappend > > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src > > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files > > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files/boot.cmd.in > > - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/rpi-u-boot-scr.bb > > - meta-raspberrypi/recipes-bsp/u-boot > > - meta-raspberrypi/recipes-bsp/u-boot/u-boot > > - meta-raspberrypi/recipes-bsp/u-boot/u-boot/*.patch > > - meta-raspberrypi/recipes-bsp/u-boot/u-boot_%.bbappend > > - meta-raspberrypi/recipes-connectivity > > - meta-raspberrypi/recipes-connectivity/bluez5 > > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5 > > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/*.patch > > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/BCM43430A1.hcd > > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5brcm43438.service > > - meta-raspberrypi/recipes-connectivity/bluez5/bluez5_%.bbappend > > - meta-raspberrypi/recipes-core > > - meta-raspberrypi/recipes-core/images > > - meta-raspberrypi/recipes-core/images/rpi-basic-image.bb > > - meta-raspberrypi/recipes-core/images/rpi-hwup-image.bb > > - meta-raspberrypi/recipes-core/images/rpi-test-image.bb > > - meta-raspberrypi/recipes-core/packagegroups > > - meta-raspberrypi/recipes-core/packagegroups/packagegroup-rpi-test.bb > > - meta-raspberrypi/recipes-core/psplash > > - meta-raspberrypi/recipes-core/psplash/files > > - meta-raspberrypi/recipes-core/psplash/files/psplash-raspberrypi-img.h > > - meta-raspberrypi/recipes-core/psplash/psplash_git.bbappend > > - meta-raspberrypi/recipes-core/udev > > - meta-raspberrypi/recipes-core/udev/udev-rules-rpi > > - meta-raspberrypi/recipes-core/udev/udev-rules-rpi/99-com.rules > > - meta-raspberrypi/recipes-core/udev/udev-rules-rpi.bb > > - meta-raspberrypi/recipes-devtools > > - meta-raspberrypi/recipes-devtools/bcm2835 > > - meta-raspberrypi/recipes-devtools/bcm2835/bcm2835_1.52.bb > > - meta-raspberrypi/recipes-devtools/pi-blaster > > - meta-raspberrypi/recipes-devtools/pi-blaster/files > > - meta-raspberrypi/recipes-devtools/pi-blaster/files/*.patch > > - meta-raspberrypi/recipes-devtools/pi-blaster/pi-blaster_git.bb > > - meta-raspberrypi/recipes-devtools/python > > - meta-raspberrypi/recipes-devtools/python/python-rtimu > > - meta-raspberrypi/recipes-devtools/python/python-rtimu/*.patch > > - meta-raspberrypi/recipes-devtools/python/python-rtimu_git.bb > > - meta-raspberrypi/recipes-devtools/python/python-sense-hat_2.2.0.bb > > - meta-raspberrypi/recipes-devtools/python/rpi-gpio > > - meta-raspberrypi/recipes-devtools/python/rpi-gpio/*.patch > > - meta-raspberrypi/recipes-devtools/python/rpi-gpio_0.6.3.bb > > - meta-raspberrypi/recipes-devtools/python/rpio > > - meta-raspberrypi/recipes-devtools/python/rpio/*.patch > > - meta-raspberrypi/recipes-devtools/python/rpio_0.10.0.bb > > - meta-raspberrypi/recipes-devtools/wiringPi > > - meta-raspberrypi/recipes-devtools/wiringPi/files > > - meta-raspberrypi/recipes-devtools/wiringPi/files/*.patch > > - meta-raspberrypi/recipes-devtools/wiringPi/wiringpi_git.bb > > - meta-raspberrypi/recipes-graphics > > - meta-raspberrypi/recipes-graphics/eglinfo > > - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-fb_%.bbappend > > - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-x11_%.bbappend > > - meta-raspberrypi/recipes-graphics/mesa > > - meta-raspberrypi/recipes-graphics/mesa/mesa-gl_%.bbappend > > - meta-raspberrypi/recipes-graphics/mesa/mesa_%.bbappend > > - meta-raspberrypi/recipes-graphics/userland > > - meta-raspberrypi/recipes-graphics/userland/userland > > - meta-raspberrypi/recipes-graphics/userland/userland/*.patch > > - meta-raspberrypi/recipes-graphics/userland/userland_git.bb > > - meta-raspberrypi/recipes-graphics/vc-graphics > > - meta-raspberrypi/recipes-graphics/vc-graphics/files > > - meta-raspberrypi/recipes-graphics/vc-graphics/files/egl.pc > > - meta-raspberrypi/recipes-graphics/vc-graphics/files/vchiq.sh > > - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics-hardfp.bb > > - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.bb > > - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.inc > > - meta-raspberrypi/recipes-graphics/wayland > > - meta-raspberrypi/recipes-graphics/wayland/weston_%.bbappend > > - meta-raspberrypi/recipes-graphics/xorg-xserver > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/10-evdev.conf > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/98-pitft.conf > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/99-calibration.conf > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend > > - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xorg_%.bbappend > > - meta-raspberrypi/recipes-kernel > > - meta-raspberrypi/recipes-kernel/linux-firmware > > - meta-raspberrypi/recipes-kernel/linux-firmware/files > > - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcmfmac43430-sdio.bin > > - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcfmac43430-sdio.txt > > - meta-raspberrypi/recipes-kernel/linux-firmware/linux-firmware_%.bbappend > > - meta-raspberrypi/recipes-kernel/linux > > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi-dev.bb > > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi.inc > > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.14.bb > > - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.9.bb > > - meta-raspberrypi/recipes-multimedia > > - meta-raspberrypi/recipes-multimedia/gstreamer > > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx > > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx/*.patch > > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx_%.bbappend > > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-plugins-bad_%.bbappend > > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12 > > - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12/*.patch > > - meta-raspberrypi/recipes-multimedia/omxplayer > > - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer > > - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer/*.patch > > - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer_git.bb > > - meta-raspberrypi/recipes-multimedia/x264 > > - meta-raspberrypi/recipes-multimedia/x264/x264_git.bbappend > > - meta-raspberrypi/wic meta-raspberrypi/wic/sdimage-raspberrypi.wks > > + ├── classes/ > > + │ └── sdcard_image-rpi.bbclass > > + ├── conf/ > > + │ ├── layer.conf > > + │ └── machine/ > > + ├── COPYING.MIT > > + ├── docs/ > > + ├── dynamic-layers/ > > + │ ├── meta-python/ > > + │ ├── multimedia-layer/ > > + │ ├── networking-layer/ > > + │ ├── openembedded-layer/ > > + │ └── qt5-layer/ > > + ├── files/ > > + │ └── custom-licenses/ > > + ├── kas-poky-rpi.yml > > + ├── lib/ > > + │ └── oeqa/ > > + ├── README.md > > + ├── recipes-bsp/ > > + │ ├── armstubs/ > > + │ ├── bootfiles/ > > + │ ├── common/ > > + │ ├── formfactor/ > > + │ ├── gpio-shutdown/ > > + │ ├── rpi-eeprom/ > > + │ ├── rpi-u-boot-scr/ > > + │ └── u-boot/ > > + ├── recipes-connectivity/ > > + │ ├── bluez5/ > > + │ └── pi-bluetooth/ > > + ├── recipes-core/ > > + │ ├── images/ > > + │ ├── packagegroups/ > > + │ ├── psplash/ > > + │ └── udev/ > > + ├── recipes-devtools/ > > + │ ├── bcm2835/ > > + │ ├── pi-blaster/ > > + │ ├── python/ > > + │ ├── raspi-gpio/ > > + │ └── raspi-utils/ > > + ├── recipes-graphics/ > > + │ ├── cairo/ > > + │ ├── kmscube/ > > + │ ├── libsdl2/ > > + │ ├── libva/ > > + │ ├── mesa/ > > + │ ├── piglit/ > > + │ ├── raspidmx/ > > + │ ├── userland/ > > + │ ├── vc-graphics/ > > + │ ├── wayland/ > > + │ └── xorg-xserver/ > > + ├── recipes-kernel/ > > + │ ├── bluez-firmware-rpidistro/ > > + │ ├── linux/ > > + │ └── linux-firmware-rpidistro/ > > + ├── recipes-multimedia/ > > + │ ├── gstreamer/ > > + │ ├── omxplayer/ > > + │ ├── picamera-libs/ > > + │ ├── python3-picamera/ > > + │ ├── rpidistro-ffmpeg/ > > + │ └── x264/ > > + ├── recipes-sato/ > > + │ └── libwpe_%.bbappend > > + ├── SECURITY.md > > + └── wic/ > > + └── sdimage-raspberrypi.wks > > Code blocks need to be indented with three spaces (here two). > > I think it would be good to keep at least one directory showing the > structure for a recipe (the bb file, a patch, etc), like > python-rtimu in the previous code block for example. ok, i'll hold off until others have a chance to opine on this. rday
Hi all, On 6/17/25 2:12 PM, Antonin Godard via lists.yoctoproject.org wrote: > Hi, > > On Tue Jun 17, 2025 at 11:52 AM CEST, Robert P. J. Day wrote: >> >> It seems overly verbose to list the entire contents of the >> meta-raspberrypi layer, so this replaces all of that output with a >> shortened version displaying only the more top-level directories, >> which still gives the reader a good idea of the overall structure of a >> BSP layer. >> >> If the reader wants more detail, they're free to check out the layer >> itself. >> >> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> >> >> --- >> >> diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst >> index 35972f172..97c9c1bf2 100644 >> --- a/documentation/bsp-guide/bsp.rst >> +++ b/documentation/bsp-guide/bsp.rst >> @@ -288,163 +288,82 @@ individual BSPs could differ. :: >> meta-bsp_root_name/recipes-graphics/* >> meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend >> >> -Below is an example of the Raspberry Pi BSP layer that is available from >> -the :yocto_git:`Source Repositories <>`: >> +Below is the abbreviated content of the higher levels of the >> +``meta-raspberrypi`` BSP layer that is available from the >> +:yocto_git:`Source Repositories <>`: >> >> .. code-block:: none >> >> - meta-raspberrypi/COPYING.MIT >> - meta-raspberrypi/README.md >> - meta-raspberrypi/classes >> - meta-raspberrypi/classes/sdcard_image-rpi.bbclass >> - meta-raspberrypi/conf/ >> - meta-raspberrypi/conf/layer.conf >> - meta-raspberrypi/conf/machine/ >> - meta-raspberrypi/conf/machine/raspberrypi-cm.conf >> - meta-raspberrypi/conf/machine/raspberrypi-cm3.conf >> - meta-raspberrypi/conf/machine/raspberrypi.conf >> - meta-raspberrypi/conf/machine/raspberrypi0-wifi.conf >> - meta-raspberrypi/conf/machine/raspberrypi0.conf >> - meta-raspberrypi/conf/machine/raspberrypi2.conf >> - meta-raspberrypi/conf/machine/raspberrypi3-64.conf >> - meta-raspberrypi/conf/machine/raspberrypi3.conf >> - meta-raspberrypi/conf/machine/include >> - meta-raspberrypi/conf/machine/include/rpi-base.inc >> - meta-raspberrypi/conf/machine/include/rpi-default-providers.inc >> - meta-raspberrypi/conf/machine/include/rpi-default-settings.inc >> - meta-raspberrypi/conf/machine/include/rpi-default-versions.inc >> - meta-raspberrypi/conf/machine/include/tune-arm1176jzf-s.inc >> - meta-raspberrypi/docs >> - meta-raspberrypi/docs/Makefile >> - meta-raspberrypi/docs/conf.py >> - meta-raspberrypi/docs/contributing.md >> - meta-raspberrypi/docs/extra-apps.md >> - meta-raspberrypi/docs/extra-build-config.md >> - meta-raspberrypi/docs/index.rst >> - meta-raspberrypi/docs/layer-contents.md >> - meta-raspberrypi/docs/readme.md >> - meta-raspberrypi/files >> - meta-raspberrypi/files/custom-licenses >> - meta-raspberrypi/files/custom-licenses/Broadcom >> - meta-raspberrypi/recipes-bsp >> - meta-raspberrypi/recipes-bsp/bootfiles >> - meta-raspberrypi/recipes-bsp/bootfiles/bcm2835-bootfiles.bb >> - meta-raspberrypi/recipes-bsp/bootfiles/rpi-config_git.bb >> - meta-raspberrypi/recipes-bsp/common >> - meta-raspberrypi/recipes-bsp/common/firmware.inc >> - meta-raspberrypi/recipes-bsp/formfactor >> - meta-raspberrypi/recipes-bsp/formfactor/formfactor >> - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi >> - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi/machconfig >> - meta-raspberrypi/recipes-bsp/formfactor/formfactor_%.bbappend >> - meta-raspberrypi/recipes-bsp/rpi-u-boot-src >> - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files >> - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files/boot.cmd.in >> - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/rpi-u-boot-scr.bb >> - meta-raspberrypi/recipes-bsp/u-boot >> - meta-raspberrypi/recipes-bsp/u-boot/u-boot >> - meta-raspberrypi/recipes-bsp/u-boot/u-boot/*.patch >> - meta-raspberrypi/recipes-bsp/u-boot/u-boot_%.bbappend >> - meta-raspberrypi/recipes-connectivity >> - meta-raspberrypi/recipes-connectivity/bluez5 >> - meta-raspberrypi/recipes-connectivity/bluez5/bluez5 >> - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/*.patch >> - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/BCM43430A1.hcd >> - meta-raspberrypi/recipes-connectivity/bluez5/bluez5brcm43438.service >> - meta-raspberrypi/recipes-connectivity/bluez5/bluez5_%.bbappend >> - meta-raspberrypi/recipes-core >> - meta-raspberrypi/recipes-core/images >> - meta-raspberrypi/recipes-core/images/rpi-basic-image.bb >> - meta-raspberrypi/recipes-core/images/rpi-hwup-image.bb >> - meta-raspberrypi/recipes-core/images/rpi-test-image.bb >> - meta-raspberrypi/recipes-core/packagegroups >> - meta-raspberrypi/recipes-core/packagegroups/packagegroup-rpi-test.bb >> - meta-raspberrypi/recipes-core/psplash >> - meta-raspberrypi/recipes-core/psplash/files >> - meta-raspberrypi/recipes-core/psplash/files/psplash-raspberrypi-img.h >> - meta-raspberrypi/recipes-core/psplash/psplash_git.bbappend >> - meta-raspberrypi/recipes-core/udev >> - meta-raspberrypi/recipes-core/udev/udev-rules-rpi >> - meta-raspberrypi/recipes-core/udev/udev-rules-rpi/99-com.rules >> - meta-raspberrypi/recipes-core/udev/udev-rules-rpi.bb >> - meta-raspberrypi/recipes-devtools >> - meta-raspberrypi/recipes-devtools/bcm2835 >> - meta-raspberrypi/recipes-devtools/bcm2835/bcm2835_1.52.bb >> - meta-raspberrypi/recipes-devtools/pi-blaster >> - meta-raspberrypi/recipes-devtools/pi-blaster/files >> - meta-raspberrypi/recipes-devtools/pi-blaster/files/*.patch >> - meta-raspberrypi/recipes-devtools/pi-blaster/pi-blaster_git.bb >> - meta-raspberrypi/recipes-devtools/python >> - meta-raspberrypi/recipes-devtools/python/python-rtimu >> - meta-raspberrypi/recipes-devtools/python/python-rtimu/*.patch >> - meta-raspberrypi/recipes-devtools/python/python-rtimu_git.bb >> - meta-raspberrypi/recipes-devtools/python/python-sense-hat_2.2.0.bb >> - meta-raspberrypi/recipes-devtools/python/rpi-gpio >> - meta-raspberrypi/recipes-devtools/python/rpi-gpio/*.patch >> - meta-raspberrypi/recipes-devtools/python/rpi-gpio_0.6.3.bb >> - meta-raspberrypi/recipes-devtools/python/rpio >> - meta-raspberrypi/recipes-devtools/python/rpio/*.patch >> - meta-raspberrypi/recipes-devtools/python/rpio_0.10.0.bb >> - meta-raspberrypi/recipes-devtools/wiringPi >> - meta-raspberrypi/recipes-devtools/wiringPi/files >> - meta-raspberrypi/recipes-devtools/wiringPi/files/*.patch >> - meta-raspberrypi/recipes-devtools/wiringPi/wiringpi_git.bb >> - meta-raspberrypi/recipes-graphics >> - meta-raspberrypi/recipes-graphics/eglinfo >> - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-fb_%.bbappend >> - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-x11_%.bbappend >> - meta-raspberrypi/recipes-graphics/mesa >> - meta-raspberrypi/recipes-graphics/mesa/mesa-gl_%.bbappend >> - meta-raspberrypi/recipes-graphics/mesa/mesa_%.bbappend >> - meta-raspberrypi/recipes-graphics/userland >> - meta-raspberrypi/recipes-graphics/userland/userland >> - meta-raspberrypi/recipes-graphics/userland/userland/*.patch >> - meta-raspberrypi/recipes-graphics/userland/userland_git.bb >> - meta-raspberrypi/recipes-graphics/vc-graphics >> - meta-raspberrypi/recipes-graphics/vc-graphics/files >> - meta-raspberrypi/recipes-graphics/vc-graphics/files/egl.pc >> - meta-raspberrypi/recipes-graphics/vc-graphics/files/vchiq.sh >> - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics-hardfp.bb >> - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.bb >> - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.inc >> - meta-raspberrypi/recipes-graphics/wayland >> - meta-raspberrypi/recipes-graphics/wayland/weston_%.bbappend >> - meta-raspberrypi/recipes-graphics/xorg-xserver >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/10-evdev.conf >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/98-pitft.conf >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/99-calibration.conf >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend >> - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xorg_%.bbappend >> - meta-raspberrypi/recipes-kernel >> - meta-raspberrypi/recipes-kernel/linux-firmware >> - meta-raspberrypi/recipes-kernel/linux-firmware/files >> - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcmfmac43430-sdio.bin >> - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcfmac43430-sdio.txt >> - meta-raspberrypi/recipes-kernel/linux-firmware/linux-firmware_%.bbappend >> - meta-raspberrypi/recipes-kernel/linux >> - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi-dev.bb >> - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi.inc >> - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.14.bb >> - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.9.bb >> - meta-raspberrypi/recipes-multimedia >> - meta-raspberrypi/recipes-multimedia/gstreamer >> - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx >> - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx/*.patch >> - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx_%.bbappend >> - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-plugins-bad_%.bbappend >> - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12 >> - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12/*.patch >> - meta-raspberrypi/recipes-multimedia/omxplayer >> - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer >> - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer/*.patch >> - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer_git.bb >> - meta-raspberrypi/recipes-multimedia/x264 >> - meta-raspberrypi/recipes-multimedia/x264/x264_git.bbappend >> - meta-raspberrypi/wic meta-raspberrypi/wic/sdimage-raspberrypi.wks >> + ├── classes/ >> + │ └── sdcard_image-rpi.bbclass >> + ├── conf/ >> + │ ├── layer.conf >> + │ └── machine/ >> + ├── COPYING.MIT >> + ├── docs/ >> + ├── dynamic-layers/ >> + │ ├── meta-python/ >> + │ ├── multimedia-layer/ >> + │ ├── networking-layer/ >> + │ ├── openembedded-layer/ >> + │ └── qt5-layer/ >> + ├── files/ >> + │ └── custom-licenses/ >> + ├── kas-poky-rpi.yml >> + ├── lib/ >> + │ └── oeqa/ >> + ├── README.md >> + ├── recipes-bsp/ >> + │ ├── armstubs/ >> + │ ├── bootfiles/ >> + │ ├── common/ >> + │ ├── formfactor/ >> + │ ├── gpio-shutdown/ >> + │ ├── rpi-eeprom/ >> + │ ├── rpi-u-boot-scr/ >> + │ └── u-boot/ >> + ├── recipes-connectivity/ >> + │ ├── bluez5/ >> + │ └── pi-bluetooth/ >> + ├── recipes-core/ >> + │ ├── images/ >> + │ ├── packagegroups/ >> + │ ├── psplash/ >> + │ └── udev/ >> + ├── recipes-devtools/ >> + │ ├── bcm2835/ >> + │ ├── pi-blaster/ >> + │ ├── python/ >> + │ ├── raspi-gpio/ >> + │ └── raspi-utils/ >> + ├── recipes-graphics/ >> + │ ├── cairo/ >> + │ ├── kmscube/ >> + │ ├── libsdl2/ >> + │ ├── libva/ >> + │ ├── mesa/ >> + │ ├── piglit/ >> + │ ├── raspidmx/ >> + │ ├── userland/ >> + │ ├── vc-graphics/ >> + │ ├── wayland/ >> + │ └── xorg-xserver/ >> + ├── recipes-kernel/ >> + │ ├── bluez-firmware-rpidistro/ >> + │ ├── linux/ >> + │ └── linux-firmware-rpidistro/ >> + ├── recipes-multimedia/ >> + │ ├── gstreamer/ >> + │ ├── omxplayer/ >> + │ ├── picamera-libs/ >> + │ ├── python3-picamera/ >> + │ ├── rpidistro-ffmpeg/ >> + │ └── x264/ >> + ├── recipes-sato/ >> + │ └── libwpe_%.bbappend >> + ├── SECURITY.md >> + └── wic/ >> + └── sdimage-raspberrypi.wks > > Code blocks need to be indented with three spaces (here two). > > I think it would be good to keep at least one directory showing the structure > for a recipe (the bb file, a patch, etc), like python-rtimu in the previous code > block for example. > Not sure it actually helps. I can understand it's unnecessarily verbose, but does the information still makes sense with only a 2-level deep `tree` output? Another way could be to only print files and not directories, a few lines would be gone for sure. Something like find -type f maybe? Also, we probably don't need the root files, nor the docs/ directory? We can replace filepaths where multiple files ends with the same extension (e.g. .patch) with one entry with a glob path for example (like *.patch). Cheers, Quentin
On Tue, 17 Jun 2025, Quentin Schulz wrote: > Hi all, > > On 6/17/25 2:12 PM, Antonin Godard via lists.yoctoproject.org wrote: > > Hi, > > > > On Tue Jun 17, 2025 at 11:52 AM CEST, Robert P. J. Day wrote: > > > > > > It seems overly verbose to list the entire contents of the > > > meta-raspberrypi layer, so this replaces all of that output with a > > > shortened version displaying only the more top-level directories, > > > which still gives the reader a good idea of the overall structure of a > > > BSP layer. > > > > > > If the reader wants more detail, they're free to check out the layer > > > itself. > > > > > > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> > > > > > > --- > > > > > > diff --git a/documentation/bsp-guide/bsp.rst > > > b/documentation/bsp-guide/bsp.rst > > > index 35972f172..97c9c1bf2 100644 > > > --- a/documentation/bsp-guide/bsp.rst > > > +++ b/documentation/bsp-guide/bsp.rst > > > @@ -288,163 +288,82 @@ individual BSPs could differ. :: > > > meta-bsp_root_name/recipes-graphics/* > > > meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend > > > > > > -Below is an example of the Raspberry Pi BSP layer that is available from > > > -the :yocto_git:`Source Repositories <>`: > > > +Below is the abbreviated content of the higher levels of the > > > +``meta-raspberrypi`` BSP layer that is available from the > > > +:yocto_git:`Source Repositories <>`: > > > > > > .. code-block:: none > > > ... BIG snip ... > > Code blocks need to be indented with three spaces (here two). > > > > I think it would be good to keep at least one directory showing the > > structure > > for a recipe (the bb file, a patch, etc), like python-rtimu in the previous > > code > > block for example. > > > > Not sure it actually helps. I can understand it's unnecessarily verbose, but > does the information still makes sense with only a 2-level deep `tree` output? > > Another way could be to only print files and not directories, a few lines > would be gone for sure. > > Something like > > find -type f > > maybe? > > Also, we probably don't need the root files, nor the docs/ directory? > > We can replace filepaths where multiple files ends with the same extension > (e.g. .patch) with one entry with a glob path for example (like *.patch). i didn't mean for this to be such an issue, it just seemed like there was an awful lot of content for ... well, what exactly is all that content supposed to *explaining*? that is, what is its purpose in the context of a BSP guide? clarifyng that might be useful. rday
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 35972f172..97c9c1bf2 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -288,163 +288,82 @@ individual BSPs could differ. :: meta-bsp_root_name/recipes-graphics/* meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend -Below is an example of the Raspberry Pi BSP layer that is available from -the :yocto_git:`Source Repositories <>`: +Below is the abbreviated content of the higher levels of the +``meta-raspberrypi`` BSP layer that is available from the +:yocto_git:`Source Repositories <>`: .. code-block:: none - meta-raspberrypi/COPYING.MIT - meta-raspberrypi/README.md - meta-raspberrypi/classes - meta-raspberrypi/classes/sdcard_image-rpi.bbclass - meta-raspberrypi/conf/ - meta-raspberrypi/conf/layer.conf - meta-raspberrypi/conf/machine/ - meta-raspberrypi/conf/machine/raspberrypi-cm.conf - meta-raspberrypi/conf/machine/raspberrypi-cm3.conf - meta-raspberrypi/conf/machine/raspberrypi.conf - meta-raspberrypi/conf/machine/raspberrypi0-wifi.conf - meta-raspberrypi/conf/machine/raspberrypi0.conf - meta-raspberrypi/conf/machine/raspberrypi2.conf - meta-raspberrypi/conf/machine/raspberrypi3-64.conf - meta-raspberrypi/conf/machine/raspberrypi3.conf - meta-raspberrypi/conf/machine/include - meta-raspberrypi/conf/machine/include/rpi-base.inc - meta-raspberrypi/conf/machine/include/rpi-default-providers.inc - meta-raspberrypi/conf/machine/include/rpi-default-settings.inc - meta-raspberrypi/conf/machine/include/rpi-default-versions.inc - meta-raspberrypi/conf/machine/include/tune-arm1176jzf-s.inc - meta-raspberrypi/docs - meta-raspberrypi/docs/Makefile - meta-raspberrypi/docs/conf.py - meta-raspberrypi/docs/contributing.md - meta-raspberrypi/docs/extra-apps.md - meta-raspberrypi/docs/extra-build-config.md - meta-raspberrypi/docs/index.rst - meta-raspberrypi/docs/layer-contents.md - meta-raspberrypi/docs/readme.md - meta-raspberrypi/files - meta-raspberrypi/files/custom-licenses - meta-raspberrypi/files/custom-licenses/Broadcom - meta-raspberrypi/recipes-bsp - meta-raspberrypi/recipes-bsp/bootfiles - meta-raspberrypi/recipes-bsp/bootfiles/bcm2835-bootfiles.bb - meta-raspberrypi/recipes-bsp/bootfiles/rpi-config_git.bb - meta-raspberrypi/recipes-bsp/common - meta-raspberrypi/recipes-bsp/common/firmware.inc - meta-raspberrypi/recipes-bsp/formfactor - meta-raspberrypi/recipes-bsp/formfactor/formfactor - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi - meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi/machconfig - meta-raspberrypi/recipes-bsp/formfactor/formfactor_%.bbappend - meta-raspberrypi/recipes-bsp/rpi-u-boot-src - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files/boot.cmd.in - meta-raspberrypi/recipes-bsp/rpi-u-boot-src/rpi-u-boot-scr.bb - meta-raspberrypi/recipes-bsp/u-boot - meta-raspberrypi/recipes-bsp/u-boot/u-boot - meta-raspberrypi/recipes-bsp/u-boot/u-boot/*.patch - meta-raspberrypi/recipes-bsp/u-boot/u-boot_%.bbappend - meta-raspberrypi/recipes-connectivity - meta-raspberrypi/recipes-connectivity/bluez5 - meta-raspberrypi/recipes-connectivity/bluez5/bluez5 - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/*.patch - meta-raspberrypi/recipes-connectivity/bluez5/bluez5/BCM43430A1.hcd - meta-raspberrypi/recipes-connectivity/bluez5/bluez5brcm43438.service - meta-raspberrypi/recipes-connectivity/bluez5/bluez5_%.bbappend - meta-raspberrypi/recipes-core - meta-raspberrypi/recipes-core/images - meta-raspberrypi/recipes-core/images/rpi-basic-image.bb - meta-raspberrypi/recipes-core/images/rpi-hwup-image.bb - meta-raspberrypi/recipes-core/images/rpi-test-image.bb - meta-raspberrypi/recipes-core/packagegroups - meta-raspberrypi/recipes-core/packagegroups/packagegroup-rpi-test.bb - meta-raspberrypi/recipes-core/psplash - meta-raspberrypi/recipes-core/psplash/files - meta-raspberrypi/recipes-core/psplash/files/psplash-raspberrypi-img.h - meta-raspberrypi/recipes-core/psplash/psplash_git.bbappend - meta-raspberrypi/recipes-core/udev - meta-raspberrypi/recipes-core/udev/udev-rules-rpi - meta-raspberrypi/recipes-core/udev/udev-rules-rpi/99-com.rules - meta-raspberrypi/recipes-core/udev/udev-rules-rpi.bb - meta-raspberrypi/recipes-devtools - meta-raspberrypi/recipes-devtools/bcm2835 - meta-raspberrypi/recipes-devtools/bcm2835/bcm2835_1.52.bb - meta-raspberrypi/recipes-devtools/pi-blaster - meta-raspberrypi/recipes-devtools/pi-blaster/files - meta-raspberrypi/recipes-devtools/pi-blaster/files/*.patch - meta-raspberrypi/recipes-devtools/pi-blaster/pi-blaster_git.bb - meta-raspberrypi/recipes-devtools/python - meta-raspberrypi/recipes-devtools/python/python-rtimu - meta-raspberrypi/recipes-devtools/python/python-rtimu/*.patch - meta-raspberrypi/recipes-devtools/python/python-rtimu_git.bb - meta-raspberrypi/recipes-devtools/python/python-sense-hat_2.2.0.bb - meta-raspberrypi/recipes-devtools/python/rpi-gpio - meta-raspberrypi/recipes-devtools/python/rpi-gpio/*.patch - meta-raspberrypi/recipes-devtools/python/rpi-gpio_0.6.3.bb - meta-raspberrypi/recipes-devtools/python/rpio - meta-raspberrypi/recipes-devtools/python/rpio/*.patch - meta-raspberrypi/recipes-devtools/python/rpio_0.10.0.bb - meta-raspberrypi/recipes-devtools/wiringPi - meta-raspberrypi/recipes-devtools/wiringPi/files - meta-raspberrypi/recipes-devtools/wiringPi/files/*.patch - meta-raspberrypi/recipes-devtools/wiringPi/wiringpi_git.bb - meta-raspberrypi/recipes-graphics - meta-raspberrypi/recipes-graphics/eglinfo - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-fb_%.bbappend - meta-raspberrypi/recipes-graphics/eglinfo/eglinfo-x11_%.bbappend - meta-raspberrypi/recipes-graphics/mesa - meta-raspberrypi/recipes-graphics/mesa/mesa-gl_%.bbappend - meta-raspberrypi/recipes-graphics/mesa/mesa_%.bbappend - meta-raspberrypi/recipes-graphics/userland - meta-raspberrypi/recipes-graphics/userland/userland - meta-raspberrypi/recipes-graphics/userland/userland/*.patch - meta-raspberrypi/recipes-graphics/userland/userland_git.bb - meta-raspberrypi/recipes-graphics/vc-graphics - meta-raspberrypi/recipes-graphics/vc-graphics/files - meta-raspberrypi/recipes-graphics/vc-graphics/files/egl.pc - meta-raspberrypi/recipes-graphics/vc-graphics/files/vchiq.sh - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics-hardfp.bb - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.bb - meta-raspberrypi/recipes-graphics/vc-graphics/vc-graphics.inc - meta-raspberrypi/recipes-graphics/wayland - meta-raspberrypi/recipes-graphics/wayland/weston_%.bbappend - meta-raspberrypi/recipes-graphics/xorg-xserver - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/10-evdev.conf - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/98-pitft.conf - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config/rpi/xorg.conf.d/99-calibration.conf - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend - meta-raspberrypi/recipes-graphics/xorg-xserver/xserver-xorg_%.bbappend - meta-raspberrypi/recipes-kernel - meta-raspberrypi/recipes-kernel/linux-firmware - meta-raspberrypi/recipes-kernel/linux-firmware/files - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcmfmac43430-sdio.bin - meta-raspberrypi/recipes-kernel/linux-firmware/files/brcfmac43430-sdio.txt - meta-raspberrypi/recipes-kernel/linux-firmware/linux-firmware_%.bbappend - meta-raspberrypi/recipes-kernel/linux - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi-dev.bb - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi.inc - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.14.bb - meta-raspberrypi/recipes-kernel/linux/linux-raspberrypi_4.9.bb - meta-raspberrypi/recipes-multimedia - meta-raspberrypi/recipes-multimedia/gstreamer - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx/*.patch - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx_%.bbappend - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-plugins-bad_%.bbappend - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12 - meta-raspberrypi/recipes-multimedia/gstreamer/gstreamer1.0-omx-1.12/*.patch - meta-raspberrypi/recipes-multimedia/omxplayer - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer/*.patch - meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer_git.bb - meta-raspberrypi/recipes-multimedia/x264 - meta-raspberrypi/recipes-multimedia/x264/x264_git.bbappend - meta-raspberrypi/wic meta-raspberrypi/wic/sdimage-raspberrypi.wks + О©╫О©╫О©╫ classes/ + О©╫О©╫О©╫ О©╫О©╫О©╫ sdcard_image-rpi.bbclass + О©╫О©╫О©╫ conf/ + О©╫О©╫О©╫ О©╫О©╫О©╫ layer.conf + О©╫О©╫О©╫ О©╫О©╫О©╫ machine/ + О©╫О©╫О©╫ COPYING.MIT + О©╫О©╫О©╫ docs/ + О©╫О©╫О©╫ dynamic-layers/ + О©╫О©╫О©╫ О©╫О©╫О©╫ meta-python/ + О©╫О©╫О©╫ О©╫О©╫О©╫ multimedia-layer/ + О©╫О©╫О©╫ О©╫О©╫О©╫ networking-layer/ + О©╫О©╫О©╫ О©╫О©╫О©╫ openembedded-layer/ + О©╫О©╫О©╫ О©╫О©╫О©╫ qt5-layer/ + О©╫О©╫О©╫ files/ + О©╫О©╫О©╫ О©╫О©╫О©╫ custom-licenses/ + О©╫О©╫О©╫ kas-poky-rpi.yml + О©╫О©╫О©╫ lib/ + О©╫О©╫О©╫ О©╫О©╫О©╫ oeqa/ + О©╫О©╫О©╫ README.md + О©╫О©╫О©╫ recipes-bsp/ + О©╫О©╫О©╫ О©╫О©╫О©╫ armstubs/ + О©╫О©╫О©╫ О©╫О©╫О©╫ bootfiles/ + О©╫О©╫О©╫ О©╫О©╫О©╫ common/ + О©╫О©╫О©╫ О©╫О©╫О©╫ formfactor/ + О©╫О©╫О©╫ О©╫О©╫О©╫ gpio-shutdown/ + О©╫О©╫О©╫ О©╫О©╫О©╫ rpi-eeprom/ + О©╫О©╫О©╫ О©╫О©╫О©╫ rpi-u-boot-scr/ + О©╫О©╫О©╫ О©╫О©╫О©╫ u-boot/ + О©╫О©╫О©╫ recipes-connectivity/ + О©╫О©╫О©╫ О©╫О©╫О©╫ bluez5/ + О©╫О©╫О©╫ О©╫О©╫О©╫ pi-bluetooth/ + О©╫О©╫О©╫ recipes-core/ + О©╫О©╫О©╫ О©╫О©╫О©╫ images/ + О©╫О©╫О©╫ О©╫О©╫О©╫ packagegroups/ + О©╫О©╫О©╫ О©╫О©╫О©╫ psplash/ + О©╫О©╫О©╫ О©╫О©╫О©╫ udev/ + О©╫О©╫О©╫ recipes-devtools/ + О©╫О©╫О©╫ О©╫О©╫О©╫ bcm2835/ + О©╫О©╫О©╫ О©╫О©╫О©╫ pi-blaster/ + О©╫О©╫О©╫ О©╫О©╫О©╫ python/ + О©╫О©╫О©╫ О©╫О©╫О©╫ raspi-gpio/ + О©╫О©╫О©╫ О©╫О©╫О©╫ raspi-utils/ + О©╫О©╫О©╫ recipes-graphics/ + О©╫О©╫О©╫ О©╫О©╫О©╫ cairo/ + О©╫О©╫О©╫ О©╫О©╫О©╫ kmscube/ + О©╫О©╫О©╫ О©╫О©╫О©╫ libsdl2/ + О©╫О©╫О©╫ О©╫О©╫О©╫ libva/ + О©╫О©╫О©╫ О©╫О©╫О©╫ mesa/ + О©╫О©╫О©╫ О©╫О©╫О©╫ piglit/ + О©╫О©╫О©╫ О©╫О©╫О©╫ raspidmx/ + О©╫О©╫О©╫ О©╫О©╫О©╫ userland/ + О©╫О©╫О©╫ О©╫О©╫О©╫ vc-graphics/ + О©╫О©╫О©╫ О©╫О©╫О©╫ wayland/ + О©╫О©╫О©╫ О©╫О©╫О©╫ xorg-xserver/ + О©╫О©╫О©╫ recipes-kernel/ + О©╫О©╫О©╫ О©╫О©╫О©╫ bluez-firmware-rpidistro/ + О©╫О©╫О©╫ О©╫О©╫О©╫ linux/ + О©╫О©╫О©╫ О©╫О©╫О©╫ linux-firmware-rpidistro/ + О©╫О©╫О©╫ recipes-multimedia/ + О©╫О©╫О©╫ О©╫О©╫О©╫ gstreamer/ + О©╫О©╫О©╫ О©╫О©╫О©╫ omxplayer/ + О©╫О©╫О©╫ О©╫О©╫О©╫ picamera-libs/ + О©╫О©╫О©╫ О©╫О©╫О©╫ python3-picamera/ + О©╫О©╫О©╫ О©╫О©╫О©╫ rpidistro-ffmpeg/ + О©╫О©╫О©╫ О©╫О©╫О©╫ x264/ + О©╫О©╫О©╫ recipes-sato/ + О©╫О©╫О©╫ О©╫О©╫О©╫ libwpe_%.bbappend + О©╫О©╫О©╫ SECURITY.md + О©╫О©╫О©╫ wic/ + О©╫О©╫О©╫ sdimage-raspberrypi.wks The following sections describe each part of the proposed BSP format.
It seems overly verbose to list the entire contents of the meta-raspberrypi layer, so this replaces all of that output with a shortened version displaying only the more top-level directories, which still gives the reader a good idea of the overall structure of a BSP layer. If the reader wants more detail, they're free to check out the layer itself. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> ---