code
string
repo_name
string
path
string
language
string
license
string
size
int64
# Architecture BR2_arm=y BR2_cortex_a7=y BR2_ARM_EABIHF=y # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y # System configuration BR2_TARGET_GENERIC_HOSTNAME="a20-olinuxino" BR2_TARGET_GENERIC_ISSUE="Welcome to OLinuXino!" BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" BR2_ROOTFS_POST_BUILD_SCRIPT="board/olimex/a20_olinuxino/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/olimex/a20_olinuxino/post-image.sh" BR2_ROOTFS_POST_SCRIPT_ARGS="board/olimex/a20_olinuxino/boot.cmd $(TARGET_DIR)/boot" # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.4" BR2_LINUX_KERNEL_USE_DEFCONFIG=y BR2_LINUX_KERNEL_DEFCONFIG="sunxi" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="sun7i-a20-olinuxino-lime" BR2_LINUX_KERNEL_INSTALL_TARGET=y # Filesystem BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set # Bootloaders BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="A20-OLinuXino-Lime" BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.07" BR2_TARGET_UBOOT_NEEDS_DTC=y BR2_TARGET_UBOOT_FORMAT_BIN=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="u-boot-sunxi-with-spl.bin" # Additional tools BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_UBOOT_TOOLS=y
shibajee/buildroot
configs/olimex_a20_olinuxino_lime_defconfig
none
mit
1,339
# Architecture BR2_arm=y BR2_cortex_a7=y BR2_ARM_EABIHF=y # Linux headers same as kernel, a 3.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_4=y # System configuration BR2_TARGET_GENERIC_HOSTNAME="a20-olinuxino" BR2_TARGET_GENERIC_ISSUE="Welcome to OLinuXino!" BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" BR2_ROOTFS_POST_BUILD_SCRIPT="board/olimex/a20_olinuxino/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/olimex/a20_olinuxino/post-image.sh" BR2_ROOTFS_POST_SCRIPT_ARGS="board/olimex/a20_olinuxino/boot-mali.cmd $(TARGET_DIR)/boot" # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_TARBALL=y BR2_LINUX_KERNEL_CUSTOM_TARBALL_LOCATION="$(call github,linux-sunxi,linux-sunxi,sunxi-v3.4.103-r1)/sunxi-v3.4.103-r1.tar.gz" BR2_LINUX_KERNEL_USE_DEFCONFIG=y BR2_LINUX_KERNEL_DEFCONFIG="sun7i" BR2_LINUX_KERNEL_INSTALL_TARGET=y # sunxi packages BR2_PACKAGE_SUNXI_TOOLS=y BR2_PACKAGE_SUNXI_BOARDS=y BR2_PACKAGE_SUNXI_BOARDS_FEX_FILE="a20/a20-olinuxino_lime.fex" BR2_PACKAGE_SUNXI_MALI=y BR2_PACKAGE_SUNXI_MALI_DBG=y # Filesystem BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set # Bootloaders BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="A20-OLinuXino-Lime" BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2015.01" BR2_TARGET_UBOOT_FORMAT_BIN=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="u-boot-sunxi-with-spl.bin" # Additional tools BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_UBOOT_TOOLS=y
shibajee/buildroot
configs/olimex_a20_olinuxino_lime_mali_defconfig
none
mit
1,493
# Architecture BR2_arm=y BR2_cortex_a7=y BR2_ARM_FPU_NEON_VFPV4=y # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y # System configuration BR2_TARGET_GENERIC_HOSTNAME="a20-olinuxino" BR2_TARGET_GENERIC_ISSUE="Welcome to OLinuXino!" BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" BR2_SYSTEM_DHCP="eth0" BR2_ROOTFS_POST_BUILD_SCRIPT="board/olimex/a20_olinuxino/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/olimex/a20_olinuxino/post-image.sh" BR2_ROOTFS_POST_SCRIPT_ARGS="board/olimex/a20_olinuxino/boot.cmd $(TARGET_DIR)/boot" # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.4.2" BR2_LINUX_KERNEL_DEFCONFIG="sunxi" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="sun7i-a20-olinuxino-micro" BR2_LINUX_KERNEL_INSTALL_TARGET=y # Filesystem BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set # Bootloaders BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="A20-OLinuXino_MICRO" BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.01" BR2_TARGET_UBOOT_NEEDS_DTC=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="u-boot-sunxi-with-spl.bin" # Additional tools BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_UBOOT_TOOLS=y
shibajee/buildroot
configs/olimex_a20_olinuxino_micro_defconfig
none
mit
1,284
# Architecture BR2_arm=y BR2_arm926t=y # System BR2_TARGET_GENERIC_GETTY_PORT="ttyAMA0" # For automatic firmware loading BR2_ROOTFS_DEVICE_CREATION_DYNAMIC_MDEV=y # Kernel BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_18=y BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="3.18.2" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/olimex/imx233_olinuxino/linux-3.18.config" BR2_LINUX_KERNEL_APPENDED_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x42000000" BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx23-olinuxino" # Firmware for WiFi BR2_PACKAGE_LINUX_FIRMWARE=y BR2_PACKAGE_LINUX_FIRMWARE_ATHEROS_7010=y BR2_PACKAGE_LINUX_FIRMWARE_ATHEROS_9271=y BR2_PACKAGE_LINUX_FIRMWARE_RALINK_RT73=y BR2_PACKAGE_LINUX_FIRMWARE_RALINK_RT2XX=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_81XX=y BR2_PACKAGE_ZD1211_FIRMWARE=y # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # U-Boot BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.01" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="mx23_olinuxino" BR2_TARGET_UBOOT_FORMAT_SD=y # To generate SD Image BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y BR2_ROOTFS_POST_IMAGE_SCRIPT="board/olimex/imx233_olinuxino/post-image.sh"
shibajee/buildroot
configs/olimex_imx233_olinuxino_defconfig
none
mit
1,349
# Architecture BR2_arm=y BR2_arm926t=y # system BR2_TARGET_GENERIC_HOSTNAME="openblocks-a6" BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" # filesystem BR2_TARGET_ROOTFS_JFFS2=y BR2_TARGET_ROOTFS_JFFS2_NANDFLASH_128K=y # Linux headers same as kernel, a 3.18 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_18=y # kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="3.18.1" BR2_LINUX_KERNEL_DEFCONFIG="mvebu_v5" BR2_LINUX_KERNEL_APPENDED_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x8000" BR2_LINUX_KERNEL_INTREE_DTS_NAME="kirkwood-openblocks_a6"
shibajee/buildroot
configs/openblocks_a6_defconfig
none
mit
587
BR2_arm=y BR2_cortex_a7=y BR2_ARM_FPU_VFPV4=y BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_6=y BR2_TARGET_GENERIC_HOSTNAME="OrangePi_PC" BR2_TARGET_GENERIC_ISSUE="Welcome to Buildroot for the Orange Pi PC" BR2_ROOTFS_POST_BUILD_SCRIPT="board/orangepi/orangepipc/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/orangepi/orangepipc/post-image.sh" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.6" BR2_LINUX_KERNEL_DEFCONFIG="sunxi" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="sun8i-h3-orangepi-plus" BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.05" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="orangepi_pc" BR2_TARGET_UBOOT_NEEDS_DTC=y BR2_TARGET_UBOOT_FORMAT_CUSTOM=y BR2_TARGET_UBOOT_FORMAT_CUSTOM_NAME="u-boot-sunxi-with-spl.bin" BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y BR2_PACKAGE_HOST_UBOOT_TOOLS=y
shibajee/buildroot
configs/orangepipc_defconfig
none
mit
1,080
BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_NEON=y BR2_ARM_ENABLE_VFP=y BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_5=y BR2_ROOTFS_DEVICE_CREATION_DYNAMIC_MDEV=y BR2_TARGET_GENERIC_GETTY_PORT="ttyO2" BR2_SYSTEM_DHCP="eth0" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/pandaboard/post-image.sh" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.5" BR2_LINUX_KERNEL_DEFCONFIG="omap2plus" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="omap4-panda-es omap4-panda omap4-panda-a4" BR2_LINUX_KERNEL_INSTALL_TARGET=y BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.01" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="omap4_panda" BR2_TARGET_UBOOT_FORMAT_IMG=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="MLO" BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y
shibajee/buildroot
configs/pandaboard_defconfig
none
mit
1,000
# Architecture BR2_x86_64=y # Toolchain, required for eudev (to autoload drivers) BR2_TOOLCHAIN_BUILDROOT_WCHAR=y # System BR2_TARGET_GENERIC_GETTY_PORT="tty1" BR2_ROOTFS_DEVICE_CREATION_DYNAMIC_EUDEV=y # Required tools to create bootable media BR2_PACKAGE_HOST_GENIMAGE=y # Bootloader BR2_TARGET_GRUB2=y # Filesystem / image BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_ROOTFS_POST_IMAGE_SCRIPT="board/pc/post-image.sh" # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/x86_64/linux-4.7.config" BR2_LINUX_KERNEL_CONFIG_FRAGMENT_FILES="board/pc/linux-extras.config" BR2_LINUX_KERNEL_INSTALL_TARGET=y # Firmware BR2_PACKAGE_LINUX_FIRMWARE=y BR2_PACKAGE_LINUX_FIRMWARE_ATHEROS_9170=y BR2_PACKAGE_LINUX_FIRMWARE_ATHEROS_9271=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_3160=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_3168=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_5000=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_6000G2A=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_6000G2B=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_7260=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_7265D=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_8000C=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_8265=y BR2_PACKAGE_LINUX_FIRMWARE_RALINK_RT73=y BR2_PACKAGE_LINUX_FIRMWARE_RALINK_RT2XX=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_8169=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_81XX=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_87XX=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_88XX=y # Packages # # Use connman so that networking setup is simpler, via connmanctl tool # acpid is for seamless power button support BR2_PACKAGE_ACPID=y BR2_PACKAGE_CONNMAN=y BR2_PACKAGE_CONNMAN_CLIENT=y BR2_PACKAGE_CONNMAN_WIFI=y
shibajee/buildroot
configs/pc_x86_64_bios_defconfig
none
mit
1,857
# Architecture BR2_x86_64=y # Toolchain, required for eudev (to autoload drivers) BR2_TOOLCHAIN_BUILDROOT_WCHAR=y # System BR2_TARGET_GENERIC_GETTY_PORT="tty1" BR2_ROOTFS_DEVICE_CREATION_DYNAMIC_EUDEV=y # Required tools to create bootable media BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y # Bootloader BR2_TARGET_GRUB2=y BR2_TARGET_GRUB2_X86_64_EFI=y # Filesystem / image BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_ROOTFS_POST_IMAGE_SCRIPT="board/pc/post-image.sh" # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/x86_64/linux-4.7.config" BR2_LINUX_KERNEL_CONFIG_FRAGMENT_FILES="board/pc/linux-extras.config" BR2_LINUX_KERNEL_INSTALL_TARGET=y # Firmware BR2_PACKAGE_LINUX_FIRMWARE=y BR2_PACKAGE_LINUX_FIRMWARE_ATHEROS_9170=y BR2_PACKAGE_LINUX_FIRMWARE_ATHEROS_9271=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_3160=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_3168=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_5000=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_6000G2A=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_6000G2B=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_7260=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_7265D=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_8000C=y BR2_PACKAGE_LINUX_FIRMWARE_IWLWIFI_8265=y BR2_PACKAGE_LINUX_FIRMWARE_RALINK_RT73=y BR2_PACKAGE_LINUX_FIRMWARE_RALINK_RT2XX=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_8169=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_81XX=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_87XX=y BR2_PACKAGE_LINUX_FIRMWARE_RTL_88XX=y # Packages # # Use connman so that networking setup is simpler, via connmanctl tool # acpid is for seamless power button support BR2_PACKAGE_ACPID=y BR2_PACKAGE_CONNMAN=y BR2_PACKAGE_CONNMAN_CLIENT=y BR2_PACKAGE_CONNMAN_WIFI=y
shibajee/buildroot
configs/pc_x86_64_efi_defconfig
none
mit
1,943
# Architecture BR2_aarch64=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttyAMA0" # Filesystem # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/aarch64-virt/linux-4.7.config"
shibajee/buildroot
configs/qemu_aarch64_virt_defconfig
none
mit
494
# Architecture BR2_arm=y BR2_arm926t=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttyAMA0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/arm-versatile/linux-4.7.config" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="versatile-pb"
shibajee/buildroot
configs/qemu_arm_versatile_defconfig
none
mit
579
# Architecture BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_NEON=y BR2_ARM_ENABLE_VFP=y BR2_ARM_FPU_VFPV3D16=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttyAMA0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_DEFCONFIG="vexpress" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="vexpress-v2p-ca9"
shibajee/buildroot
configs/qemu_arm_vexpress_defconfig
none
mit
572
# Architecture BR2_m68k=y BR2_m68k_cf5208=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_INITRAMFS=y # BR2_TARGET_ROOTFS_TAR is not set BR2_GLOBAL_PATCH_DIR="board/qemu/m68k-mcf5208/patches" # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/m68k-mcf5208/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" # use minimal busybox with hush and networking tools BR2_PACKAGE_BUSYBOX_CONFIG="package/busybox/busybox-minimal.config"
shibajee/buildroot
configs/qemu_m68k_mcf5208_defconfig
none
mit
761
# Architecture BR2_m68k=y BR2_m68k_68040=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/m68k-q800/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_m68k_q800_defconfig
none
mit
574
# Architecture BR2_microblaze=y BR2_microblazebe=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttyUL0" # Filesystem # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/microblazebe-mmu/linux-4.7.config" BR2_LINUX_KERNEL_LINUX_BIN=y BR2_LINUX_KERNEL_PATCH="board/qemu/microblazebe-mmu/xilinx-xemaclite.patch"
shibajee/buildroot
configs/qemu_microblazebe_mmu_defconfig
none
mit
624
# Architecture BR2_microblaze=y BR2_microblazeel=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttyUL0" # Filesystem # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/microblazeel-mmu/linux-4.7.config" BR2_LINUX_KERNEL_LINUX_BIN=y BR2_LINUX_KERNEL_PATCH="board/qemu/microblazeel-mmu/xilinx-xemaclite.patch"
shibajee/buildroot
configs/qemu_microblazeel_mmu_defconfig
none
mit
624
# Architecture BR2_mips=y BR2_mips_32r2=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips32r2-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips32r2_malta_defconfig
none
mit
578
# Architecture BR2_mipsel=y BR2_mips_32r2=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips32r2el-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips32r2el_malta_defconfig
none
mit
582
# Architecture BR2_mips=y BR2_mips_32r6=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips32r6-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Compiler # linux >= 4.4 uses -mcompact-branches which is only available since gcc-6 BR2_GCC_VERSION_6_X=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips32r6_malta_defconfig
none
mit
687
# Architecture BR2_mipsel=y BR2_mips_32r6=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips32r6el-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Compiler # linux >= 4.4 uses -mcompact-branches which is only available since GCC 6.x BR2_GCC_VERSION_6_X=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips32r6el_malta_defconfig
none
mit
693
# Architecture BR2_mips64=y BR2_MIPS_NABI64=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips64-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips64_malta_defconfig
none
mit
580
# Architecture BR2_mips64el=y BR2_MIPS_NABI64=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips64el-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips64el_malta_defconfig
none
mit
584
# Architecture BR2_mips64=y BR2_mips_64r6=y BR2_MIPS_NABI64=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips64r6-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Compiler # linux >= 4.4 uses -mcompact-branches which is only available since gcc-6 BR2_GCC_VERSION_6_X=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips64r6_malta_defconfig
none
mit
707
# Architecture BR2_mips64el=y BR2_mips_64r6=y BR2_MIPS_NABI64=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/mips64r6el-malta/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Compiler # linux >= 4.4 uses -mcompact-branches which is only available since gcc-6 BR2_GCC_VERSION_6_X=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_mips64r6el_malta_defconfig
none
mit
711
# Architecture BR2_powerpc64=y BR2_powerpc_power7=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="hvc0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_DEFCONFIG="pseries" BR2_LINUX_KERNEL_VMLINUX=y
shibajee/buildroot
configs/qemu_ppc64_pseries_defconfig
none
mit
457
# Architecture BR2_powerpc=y BR2_powerpc_750=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/ppc-g3beige/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_ppc_g3beige_defconfig
none
mit
580
# Architecture BR2_powerpc=y BR2_powerpc_8548=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/ppc-mpc8544ds/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y # Serial port config BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0"
shibajee/buildroot
configs/qemu_ppc_mpc8544ds_defconfig
none
mit
588
# Architecture BR2_powerpc=y BR2_powerpc_440=y # Filesystem # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Use soft float BR2_SOFT_FLOAT=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/ppc-virtex-ml507/linux-4.7.config" BR2_LINUX_KERNEL_VMLINUX=y BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="virtex440-ml507"
shibajee/buildroot
configs/qemu_ppc_virtex_ml507_defconfig
none
mit
587
# Architecture BR2_sh=y BR2_sh4=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttySC1" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Linux kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/sh4-r2d/linux-4.7.config" BR2_LINUX_KERNEL_ZIMAGE=y
shibajee/buildroot
configs/qemu_sh4_r2d_defconfig
none
mit
520
# Architecture BR2_sh=y BR2_sh4eb=y # System BR2_TARGET_GENERIC_GETTY_PORT="ttySC1" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Linux kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/sh4eb-r2d/linux-4.7.config" BR2_LINUX_KERNEL_ZIMAGE=y
shibajee/buildroot
configs/qemu_sh4eb_r2d_defconfig
none
mit
501
# Architecture BR2_sparc64=y BR2_sparc_v9=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Linux kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/sparc64-sun4u/linux-4.7.config"
shibajee/buildroot
configs/qemu_sparc64_sun4u_defconfig
none
mit
471
# Architecture BR2_sparc=y BR2_sparc_v8=y # System BR2_SYSTEM_DHCP="eth0" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Linux kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/sparc-ss10/linux-4.7.config"
shibajee/buildroot
configs/qemu_sparc_ss10_defconfig
none
mit
466
# Architecture BR2_x86_64=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="tty1" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/x86_64/linux-4.7.config"
shibajee/buildroot
configs/qemu_x86_64_defconfig
none
mit
479
# Architecture BR2_i386=y BR2_x86_pentiumpro=y # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="tty1" # Filesystem BR2_TARGET_ROOTFS_EXT2=y # BR2_TARGET_ROOTFS_TAR is not set # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/x86/linux-4.7.config"
shibajee/buildroot
configs/qemu_x86_defconfig
none
mit
495
# Architecture BR2_xtensa=y BR2_XTENSA_CUSTOM=y BR2_XTENSA_CUSTOM_NAME="dc233c" BR2_XTENSA_CORE_NAME="lx60" BR2_XTENSA_OVERLAY_DIR="board/qemu/xtensa-lx60" # Patches BR2_GLOBAL_PATCH_DIR="board/qemu/xtensa-lx60" # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" # Filesystem # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/xtensa-lx60/linux-4.7.config" BR2_LINUX_KERNEL_IMAGE_TARGET_CUSTOM=y BR2_LINUX_KERNEL_IMAGE_NAME="Image.elf" BR2_LINUX_KERNEL_IMAGE_TARGET_NAME="zImage"
shibajee/buildroot
configs/qemu_xtensa_lx60_defconfig
none
mit
798
# Architecture BR2_xtensa=y BR2_XTENSA_CUSTOM=y BR2_XTENSA_CUSTOM_NAME="dc233c" BR2_XTENSA_CORE_NAME="lx60" BR2_XTENSA_OVERLAY_DIR="board/qemu/xtensa-lx60" # Toolchain BR2_PACKAGE_HOST_ELF2FLT=y # BR2_USE_MMU is not set # Patches BR2_GLOBAL_PATCH_DIR="board/qemu/xtensa-lx60" # System BR2_SYSTEM_DHCP="eth0" BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" # Filesystem # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/qemu/xtensa-lx60/linux-4.7-nommu.config" BR2_LINUX_KERNEL_IMAGE_TARGET_CUSTOM=y BR2_LINUX_KERNEL_IMAGE_NAME="Image.elf" BR2_LINUX_KERNEL_IMAGE_TARGET_NAME="zImage"
shibajee/buildroot
configs/qemu_xtensa_lx60_nommu_defconfig
none
mit
869
BR2_arm=y BR2_cortex_a9=y # Linux headers same as kernel, a 3.14 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_14=y BR2_TARGET_GENERIC_GETTY_PORT="ttymxc1" # Notice you need a recent version of u-boot (with DT support) to be able # to boot this kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://git.congatec.com/arm/imx6_kernel_3.14.git" # Last version of branch cgt_qmx6_3.14.28_1.0.0 BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="105820d6bd251deb49c3dd3f71fa0d76adce97c7" BR2_LINUX_KERNEL_DEFCONFIG="qmx6" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x10008000" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx6q-qmx6" BR2_LINUX_KERNEL_INSTALL_TARGET=y # Change boardname depending of your product number BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="cgt_qmx6_pn016103" BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="https://git.congatec.com/arm/qmx6_uboot.git" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="4d3b64e93064ed3d97ef7d91ff0f61a693a460fc" BR2_TARGET_UBOOT_FORMAT_CUSTOM=y BR2_TARGET_UBOOT_FORMAT_CUSTOM_NAME="u-boot.pn016103.imx" BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_3=y BR2_PACKAGE_HOST_UBOOT_TOOLS=y
shibajee/buildroot
configs/qmx6_defconfig
none
mit
1,217
BR2_arm=y BR2_arm1176jzf_s=y BR2_ARM_EABIHF=y # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_TOOLCHAIN_BUILDROOT_CXX=y BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/raspberrypi/linux.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="26f3b72a9c049be10e6af196252283e1f6ab9d1f" BR2_LINUX_KERNEL_DEFCONFIG="bcmrpi" # Build the DTBs for A/B from the kernel sources: the zero is the same # as the A+ model, just in a different form-factor BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="bcm2708-rpi-b-plus" BR2_PACKAGE_RPI_FIRMWARE=y # BR2_PACKAGE_RPI_FIRMWARE_INSTALL_DTB_OVERLAYS is not set # Required tools to create the SD image BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y # Filesystem / image BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_ROOTFS_POST_BUILD_SCRIPT="board/raspberrypi0/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/raspberrypi0/post-image.sh"
shibajee/buildroot
configs/raspberrypi0_defconfig
none
mit
1,066
BR2_arm=y BR2_cortex_a7=y BR2_ARM_EABIHF=y BR2_ARM_FPU_NEON_VFPV4=y BR2_TOOLCHAIN_BUILDROOT_CXX=y BR2_SYSTEM_DHCP="eth0" # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/raspberrypi/linux.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="26f3b72a9c049be10e6af196252283e1f6ab9d1f" BR2_LINUX_KERNEL_DEFCONFIG="bcm2709" # Build the DTB from the kernel sources BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="bcm2709-rpi-2-b" BR2_PACKAGE_RPI_FIRMWARE=y # BR2_PACKAGE_RPI_FIRMWARE_INSTALL_DTB_OVERLAYS is not set # Required tools to create the SD image BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y # Filesystem / image BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_ROOTFS_POST_BUILD_SCRIPT="board/raspberrypi2/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/raspberrypi2/post-image.sh"
shibajee/buildroot
configs/raspberrypi2_defconfig
none
mit
1,028
BR2_arm=y BR2_cortex_a7=y BR2_ARM_EABIHF=y BR2_ARM_FPU_NEON_VFPV4=y BR2_TOOLCHAIN_BUILDROOT_CXX=y BR2_SYSTEM_DHCP="eth0" # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/raspberrypi/linux.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="26f3b72a9c049be10e6af196252283e1f6ab9d1f" BR2_LINUX_KERNEL_DEFCONFIG="bcm2709" # Build the DTB from the kernel sources BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="bcm2710-rpi-3-b" BR2_PACKAGE_RPI_FIRMWARE=y # BR2_PACKAGE_RPI_FIRMWARE_INSTALL_DTB_OVERLAYS is not set # Required tools to create the SD image BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y # Filesystem / image BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_ROOTFS_POST_BUILD_SCRIPT="board/raspberrypi3/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/raspberrypi3/post-image.sh"
shibajee/buildroot
configs/raspberrypi3_defconfig
none
mit
1,028
BR2_arm=y BR2_arm1176jzf_s=y BR2_ARM_EABIHF=y BR2_SYSTEM_DHCP="eth0" # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_TOOLCHAIN_BUILDROOT_CXX=y BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/raspberrypi/linux.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="26f3b72a9c049be10e6af196252283e1f6ab9d1f" BR2_LINUX_KERNEL_DEFCONFIG="bcmrpi" # Build the DTBs for A/B, A+/B+ and compute module from the kernel sources BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="bcm2708-rpi-b bcm2708-rpi-b-plus bcm2708-rpi-cm" BR2_PACKAGE_RPI_FIRMWARE=y # BR2_PACKAGE_RPI_FIRMWARE_INSTALL_DTB_OVERLAYS is not set # Required tools to create the SD image BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y # Filesystem / image BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set BR2_ROOTFS_POST_BUILD_SCRIPT="board/raspberrypi/post-build.sh" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/raspberrypi/post-image.sh"
shibajee/buildroot
configs/raspberrypi_defconfig
none
mit
1,070
# architecture BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_VFP=y # system BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttymxc1" # rootfs BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_2r1=y BR2_ROOTFS_OVERLAY="board/embest/riotboard/rootfs_overlay" # bootloader BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2015.10" BR2_TARGET_UBOOT_BOARDNAME="riotboard" BR2_TARGET_UBOOT_FORMAT_IMX=y # Linux headers same as kernel, a 4.2 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_2=y # kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.2.6" BR2_LINUX_KERNEL_DEFCONFIG="imx_v6_v7" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x10008000" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx6dl-riotboard" BR2_LINUX_KERNEL_INSTALL_TARGET=y
shibajee/buildroot
configs/riotboard_defconfig
none
mit
873
BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_NEON=y BR2_ARM_ENABLE_VFP=y BR2_GLOBAL_PATCH_DIR="board/roseapplepi/patches" # Linux headers same as kernel, a 3.10 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_10=y BR2_ROOTFS_POST_IMAGE_SCRIPT="board/roseapplepi/post-image.sh" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/xapp-le/kernel.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="59dbf6a4998e967eb9c6bdcc9b506c0d96acb26b" BR2_LINUX_KERNEL_DEFCONFIG="actduino_bubble_gum_linux" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="actduino_bubble_gum_sdboot_linux" # Filesystem / image BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set # Bootloaders BR2_TARGET_S500_BOOTLOADER=y BR2_TARGET_S500_BOOTLOADER_BOARD="linux/bubble_gum_sd" BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="https://github.com/xapp-le/u-boot.git" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="a035d2673a90143a1a74557503b2e137b1447ae6" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="actduino_bubble_gum_v10" BR2_TARGET_UBOOT_NEEDS_DTC=y BR2_TARGET_UBOOT_FORMAT_DTB_IMG=y # Required tools to create the SD image BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y
shibajee/buildroot
configs/roseapplepi_defconfig
none
mit
1,353
BR2_microblaze=y BR2_microblazeel=y # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_TARGET_GENERIC_GETTY_PORT="ttyUL0" # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_ROOTFS_INITRAMFS=y BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.4.7" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/avnet/s6lx9_microboard/lx9_mmu_defconfig" BR2_LINUX_KERNEL_USE_CUSTOM_DTS=y BR2_LINUX_KERNEL_CUSTOM_DTS_PATH="board/avnet/s6lx9_microboard/lx9_mmu.dts"
shibajee/buildroot
configs/s6lx9_microboard_defconfig
none
mit
560
# Architecture BR2_arm=y BR2_arm926t=y # system BR2_TARGET_GENERIC_GETTY=y BR2_TARGET_GENERIC_GETTY_PORT="ttyS0" BR2_SYSTEM_DHCP="eth0" # filesystem BR2_TARGET_ROOTFS_JFFS2=y BR2_TARGET_ROOTFS_JFFS2_NANDFLASH_128K=y # Linux headers same as kernel, a 4.6 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_6=y # bootloader BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_BOARD_DEFCONFIG="sheevaplug" BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.05" BR2_TARGET_UBOOT_FORMAT_KWB=y # BR2_TARGET_UBOOT_NETWORK is not set # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.6" BR2_LINUX_KERNEL_DEFCONFIG="mvebu_v5" BR2_LINUX_KERNEL_APPENDED_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x8000" BR2_LINUX_KERNEL_INTREE_DTS_NAME="kirkwood-sheevaplug"
shibajee/buildroot
configs/sheevaplug_defconfig
none
mit
854
BR2_aarch64=y # Linux headers same as kernel, a 3.18 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_18=y BR2_TARGET_GENERIC_HOSTNAME="vdk-buildroot" BR2_TARGET_GENERIC_ISSUE="Welcome to SNPS VDK by Buildroot" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://git.linaro.org/kernel/linux-linaro-tracking.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="linux-linaro-3.18-2014.12" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/synopsys/vdk/linux-vdk-aarch64-defconfig" BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # BR2_TARGET_ROOTFS_TAR is not set
shibajee/buildroot
configs/snps_aarch64_vdk_defconfig
none
mit
623
# Architecture BR2_arcle=y # System BR2_TARGET_GENERIC_HOSTNAME="axs101" BR2_TARGET_GENERIC_ISSUE="Welcome to the ARC Software Development Platform" BR2_TARGET_ROOTFS_INITRAMFS=y BR2_SYSTEM_DHCP="eth0" BR2_ROOTFS_OVERLAY="board/synopsys/axs10x/fs-overlay" # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_DEFCONFIG="axs101" # Bootloader BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.07" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="axs101" BR2_TARGET_UBOOT_NEEDS_DTC=y
shibajee/buildroot
configs/snps_axs101_defconfig
none
mit
716
# Architecture BR2_arcle=y BR2_archs38=y # System BR2_TARGET_GENERIC_HOSTNAME="axs103" BR2_TARGET_GENERIC_ISSUE="Welcome to the ARC Software Development Platform" BR2_TARGET_ROOTFS_INITRAMFS=y BR2_SYSTEM_DHCP="eth0" BR2_ROOTFS_OVERLAY="board/synopsys/axs10x/fs-overlay" # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_DEFCONFIG="axs103_smp" # Bootloader BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.07" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="axs103" BR2_TARGET_UBOOT_NEEDS_DTC=y
shibajee/buildroot
configs/snps_axs103_defconfig
none
mit
734
# Architecture BR2_arcle=y BR2_archs38=y # System BR2_TARGET_GENERIC_HOSTNAME="hs38_vdk" BR2_TARGET_GENERIC_ISSUE="Welcome to the HS38 VDK Software Development Platform" BR2_ROOTFS_OVERLAY="board/synopsys/axs10x/fs-overlay" BR2_TARGET_ROOTFS_EXT2=y # Linux headers same as kernel, a 4.7 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_7=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.7" BR2_LINUX_KERNEL_DEFCONFIG="vdk_hs38_smp" BR2_LINUX_KERNEL_VMLINUX=y
shibajee/buildroot
configs/snps_hs38_smp_vdk_defconfig
none
mit
516
BR2_arm=y BR2_cortex_m4=y BR2_GLOBAL_PATCH_DIR="board/stmicroelectronics/stm32f429-disco/patches" BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_5=y BR2_ROOTFS_POST_BUILD_SCRIPT="board/stmicroelectronics/stm32-post-build.sh" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.5" BR2_LINUX_KERNEL_DEFCONFIG="stm32" BR2_LINUX_KERNEL_IMAGE_TARGET_CUSTOM=y BR2_LINUX_KERNEL_IMAGE_TARGET_NAME="xipImage" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="stm32f429-disco" BR2_PACKAGE_BUSYBOX_CONFIG="package/busybox/busybox-minimal.config" BR2_TARGET_ROOTFS_INITRAMFS=y # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_AFBOOT_STM32=y BR2_PACKAGE_HOST_OPENOCD=y
shibajee/buildroot
configs/stm32f429_disco_defconfig
none
mit
703
BR2_arm=y BR2_cortex_m4=y BR2_GLOBAL_PATCH_DIR="board/stmicroelectronics/stm32f469-disco/patches" BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_5=y BR2_ROOTFS_POST_BUILD_SCRIPT="board/stmicroelectronics/stm32-post-build.sh" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.5" BR2_LINUX_KERNEL_DEFCONFIG="stm32" BR2_LINUX_KERNEL_CONFIG_FRAGMENT_FILES="$(LINUX_DIR)/arch/arm/configs/dram_0x00000000.config" BR2_LINUX_KERNEL_IMAGE_TARGET_CUSTOM=y BR2_LINUX_KERNEL_IMAGE_TARGET_NAME="xipImage" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="stm32f469-disco" BR2_PACKAGE_BUSYBOX_CONFIG="package/busybox/busybox-minimal.config" BR2_TARGET_ROOTFS_INITRAMFS=y # BR2_TARGET_ROOTFS_TAR is not set BR2_TARGET_AFBOOT_STM32=y BR2_PACKAGE_HOST_OPENOCD=y
shibajee/buildroot
configs/stm32f469_disco_defconfig
none
mit
797
# Architecture BR2_arm=y BR2_arm926t=y # Linux headers same as kernel, a 3.9 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_9=y # Watchdog is armed by the first stage bootloader BR2_PACKAGE_BUSYBOX_WATCHDOG=y # Filesystem BR2_TARGET_ROOTFS_UBIFS=y BR2_TARGET_ROOTFS_UBI=y # Bootloader BR2_TARGET_BAREBOX=y BR2_TARGET_BAREBOX_CUSTOM_VERSION=y BR2_TARGET_BAREBOX_CUSTOM_VERSION_VALUE="2013.04.0" BR2_TARGET_BAREBOX_CUSTOM_PATCH_DIR="board/telit/evk-pro3" BR2_TARGET_BAREBOX_BOARD_DEFCONFIG="telit_evk_pro3" # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="3.9.1" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/telit/evk-pro3/linux-3.9.config" BR2_LINUX_KERNEL_APPENDED_ZIMAGE=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="evk-pro3"
shibajee/buildroot
configs/telit_evk_pro3_defconfig
none
mit
810
BR2_arm=y BR2_cortex_a9=y BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_14=y BR2_TARGET_GENERIC_GETTY_PORT="ttymxc0" BR2_ROOTFS_POST_IMAGE_SCRIPT="board/toradex/apalis-imx6/post-image.sh" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="git://git.toradex.com/linux-toradex.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="8f237ebe42f2cb911245369276a6b3043c2815f2" BR2_LINUX_KERNEL_DEFCONFIG="apalis_imx6" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx6q-apalis-eval imx6q-apalis-ixora imx6q-apalis_v1_0-eval imx6q-apalis_v1_0-ixora" BR2_LINUX_KERNEL_INSTALL_TARGET=y BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="git://git.toradex.com/u-boot-toradex.git" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="1ef4a29e8cea0239411dde64f9617ad76248fd02" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="apalis_imx6" BR2_TARGET_UBOOT_FORMAT_CUSTOM=y BR2_TARGET_UBOOT_FORMAT_CUSTOM_NAME="u-boot.imx" BR2_PACKAGE_HOST_GENIMAGE=y
shibajee/buildroot
configs/toradex_apalis_imx6_defconfig
none
mit
1,065
BR2_arm=y BR2_cortex_a8=y BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_6=y BR2_ROOTFS_POST_IMAGE_SCRIPT="board/technologic/ts4800/post-image.sh" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.6.3" BR2_LINUX_KERNEL_DEFCONFIG="imx_v6_v7" BR2_LINUX_KERNEL_CONFIG_FRAGMENT_FILES="board/technologic/ts4800/linux.fragment" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx51-ts4800" BR2_PACKAGE_BUSYBOX_WATCHDOG=y BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y BR2_TARGET_TS4800_MBRBOOT=y BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="ts4800" BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.07" BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y
shibajee/buildroot
configs/ts4800_defconfig
none
mit
770
# architecture BR2_i386=y BR2_x86_i586=y # Linux headers same as kernel, a 3.17 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_17=y # system BR2_TARGET_GENERIC_GETTY_PORT="ttyS1" BR2_ROOTFS_OVERLAY="board/technologic/ts5x00/fs-overlay" # kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="3.17.8" BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG=y BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE="board/technologic/ts5x00/linux-3.17.config" BR2_LINUX_KERNEL_INSTALL_TARGET=y # rootfs BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # bootloader BR2_TARGET_SYSLINUX=y BR2_TARGET_SYSLINUX_MBR=y
shibajee/buildroot
configs/ts5x00_defconfig
none
mit
624
# Architceture BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_VFP=y # Linux headers same as kernel, a 3.0 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_0=y # System BR2_TARGET_GENERIC_GETTY_PORT="ttymxc1" # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/UDOOboard/Kernel_Unico" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="8a6eb060a0d968048f88d5a94510fc6db2c37939" BR2_LINUX_KERNEL_PATCH="https://github.com/torvalds/linux/commit/455bd4c430b0c0a361f38e8658a0d6cb469942b5.patch https://github.com/torvalds/linux/commit/418df63adac56841ef6b0f1fcf435bc64d4ed177.patch" BR2_LINUX_KERNEL_DEFCONFIG="UDOO" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x10008000" BR2_LINUX_KERNEL_INSTALL_TARGET=y # Bootloader BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="udoo_quad" BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="https://github.com/UDOOboard/U-Boot_Unico-2013" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="1b90fd4bafb1efe05f88eaded731d99a1428f497" BR2_TARGET_UBOOT_FORMAT_IMX=y
shibajee/buildroot
configs/udoo_quad_defconfig
none
mit
1,053
# Architecture BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_VFP=y # Linux headers same as kernel, a 3.10 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_10=y # Kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/viaembedded/vab820-kernel-bsp.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="via_3.10.17_2.0.6" BR2_LINUX_KERNEL_DEFCONFIG="via_vab820" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x10008000" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx6q-vab820" # Bootloader BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="mx6qvab820" BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="https://github.com/viaembedded/vab820-uboot-bsp.git" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="via_3.10.17_2.0.6" BR2_TARGET_UBOOT_FORMAT_IMX=y # Filesystem BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y BR2_ROOTFS_POST_IMAGE_SCRIPT="board/via/imx6_vab820/post-image.sh"
shibajee/buildroot
configs/via_imx6_vab820_defconfig
none
mit
1,043
BR2_arm=y BR2_cortex_a9=y # Linux headers same as kernel, a 3.14 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_3_14=y BR2_TARGET_GENERIC_GETTY_PORT="ttymxc0" BR2_PACKAGE_HOST_GENIMAGE=y BR2_ROOTFS_POST_IMAGE_SCRIPT="board/wandboard/post-image.sh" BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_USE_DEFCONFIG=y BR2_TARGET_UBOOT_BOARD_DEFCONFIG="wandboard" BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2015.07" BR2_TARGET_UBOOT_FORMAT_IMG=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="SPL" BR2_TARGET_UBOOT_ENVIMAGE=y BR2_TARGET_UBOOT_ENVIMAGE_SOURCE="board/wandboard/uboot-env.txt" BR2_TARGET_UBOOT_ENVIMAGE_SIZE="0x2000" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/wandboard-org/linux" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="e2213f9a98dd7413ee5a9ca40cf60e8cb8292f4a" BR2_LINUX_KERNEL_DEFCONFIG="wandboard" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx6q-wandboard imx6dl-wandboard" BR2_LINUX_KERNEL_INSTALL_TARGET=y
shibajee/buildroot
configs/wandboard_defconfig
none
mit
1,110
# architecture BR2_arm=y BR2_cortex_a9=y # Linux headers same as kernel, a 4.4 series BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y # system BR2_TARGET_GENERIC_HOSTNAME="warpboard" BR2_TARGET_GENERIC_GETTY_PORT="ttymxc0" # rootfs overlay BR2_ROOTFS_OVERLAY="board/freescale/warpboard/rootfs_overlay" # kernel BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_VERSION=y BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="4.4.15" BR2_LINUX_KERNEL_DEFCONFIG="imx_v6_v7" BR2_LINUX_KERNEL_CONFIG_FRAGMENT_FILES="board/freescale/warpboard/linux.fragment" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="imx6sl-warp" # wifi firmware for brcm4330 BR2_PACKAGE_LINUX_FIRMWARE=y BR2_PACKAGE_LINUX_FIRMWARE_BRCM_BCM43XX=y # wireless packages BR2_PACKAGE_WIRELESS_TOOLS=y BR2_PACKAGE_WPA_SUPPLICANT=y BR2_PACKAGE_WPA_SUPPLICANT_PASSPHRASE=y # uboot BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BOARDNAME="warp" BR2_TARGET_UBOOT_CUSTOM_VERSION=y BR2_TARGET_UBOOT_CUSTOM_VERSION_VALUE="2016.07" BR2_TARGET_UBOOT_FORMAT_IMX=y # host utility BR2_PACKAGE_HOST_DFU_UTIL=y BR2_PACKAGE_HOST_IMX_USB_LOADER=y # Filesystem BR2_ROOTFS_POST_IMAGE_SCRIPT="board/freescale/warpboard/post-image.sh" BR2_TARGET_ROOTFS_EXT2=y BR2_TARGET_ROOTFS_EXT2_4=y # required tools to create the eMMC image BR2_PACKAGE_HOST_DOSFSTOOLS=y BR2_PACKAGE_HOST_GENIMAGE=y BR2_PACKAGE_HOST_MTOOLS=y
shibajee/buildroot
configs/warpboard_defconfig
none
mit
1,346
BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_NEON=y BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_TARGET_GENERIC_GETTY_PORT="ttyPS0" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/Xilinx/linux-xlnx.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="xilinx-v2016.2" BR2_LINUX_KERNEL_DEFCONFIG="xilinx_zynq" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x8000" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="zynq-zed" BR2_TARGET_ROOTFS_CPIO=y BR2_TARGET_ROOTFS_CPIO_GZIP=y BR2_TARGET_ROOTFS_CPIO_UIMAGE=y BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="https://github.com/Xilinx/u-boot-xlnx.git" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="xilinx-v2016.2" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="zynq_microzed" BR2_TARGET_UBOOT_NEEDS_DTC=y BR2_TARGET_UBOOT_FORMAT_IMG=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="spl/boot.bin"
shibajee/buildroot
configs/zynq_microzed_defconfig
none
mit
973
BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_NEON=y BR2_ARM_ENABLE_VFP=y BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_TARGET_GENERIC_GETTY_PORT="ttyPS0" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/Xilinx/linux-xlnx.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="xilinx-v2016.2" BR2_LINUX_KERNEL_DEFCONFIG="xilinx_zynq" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x8000" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="zynq-zc706" BR2_TARGET_ROOTFS_CPIO=y BR2_TARGET_ROOTFS_CPIO_GZIP=y BR2_TARGET_ROOTFS_CPIO_UIMAGE=y BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="https://github.com/Xilinx/u-boot-xlnx.git" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="xilinx-v2016.2" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="zynq_zc706" BR2_TARGET_UBOOT_NEEDS_DTC=y BR2_TARGET_UBOOT_FORMAT_IMG=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="spl/boot.bin"
shibajee/buildroot
configs/zynq_zc706_defconfig
none
mit
993
BR2_arm=y BR2_cortex_a9=y BR2_ARM_ENABLE_NEON=y BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_4_4=y BR2_TARGET_GENERIC_GETTY_PORT="ttyPS0" BR2_LINUX_KERNEL=y BR2_LINUX_KERNEL_CUSTOM_GIT=y BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/Xilinx/linux-xlnx.git" BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="xilinx-v2016.2" BR2_LINUX_KERNEL_DEFCONFIG="xilinx_zynq" BR2_LINUX_KERNEL_UIMAGE=y BR2_LINUX_KERNEL_UIMAGE_LOADADDR="0x8000" BR2_LINUX_KERNEL_DTS_SUPPORT=y BR2_LINUX_KERNEL_INTREE_DTS_NAME="zynq-zed" BR2_TARGET_ROOTFS_CPIO=y BR2_TARGET_ROOTFS_CPIO_GZIP=y BR2_TARGET_ROOTFS_CPIO_UIMAGE=y BR2_TARGET_UBOOT=y BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y BR2_TARGET_UBOOT_CUSTOM_GIT=y BR2_TARGET_UBOOT_CUSTOM_REPO_URL="https://github.com/Xilinx/u-boot-xlnx.git" BR2_TARGET_UBOOT_CUSTOM_REPO_VERSION="xilinx-v2016.2" BR2_TARGET_UBOOT_BOARD_DEFCONFIG="zynq_zed" BR2_TARGET_UBOOT_NEEDS_DTC=y BR2_TARGET_UBOOT_FORMAT_IMG=y BR2_TARGET_UBOOT_SPL=y BR2_TARGET_UBOOT_SPL_NAME="spl/boot.bin"
shibajee/buildroot
configs/zynq_zed_defconfig
none
mit
968
# Refer to following asciidoc documentation: # http://www.methods.co.nz/asciidoc/userguide.html # In particular sections "Macros" and "Attribute References" # # For hyperlinks, show 'link text [URL]' (if link text provided) or 'URL' [http-inlinemacro] {0=}{0? [}{name}:{target}{0?]} [https-inlinemacro] {0=}{0? [}{name}:{target}{0?]} [ftp-inlinemacro] {0=}{0? [}{name}:{target}{0?]} [file-inlinemacro] {0=}{0? [}{name}:{target}{0?]} [irc-inlinemacro] {0=}{0? [}{name}:{target}{0?]} [mailto-inlinemacro] {0=}{0? [}{name}:{target}{0?]} # Hide image representation from text manual [image-inlinemacro] {empty} [image-blockmacro] {empty}
shibajee/buildroot
docs/conf/asciidoc-text.conf
INI
mit
687
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[adding-board-support]] == Adding support for a particular board Buildroot contains basic configurations for several publicly available hardware boards, so that users of such a board can easily build a system that is known to work. You are welcome to add support for other boards to Buildroot too. To do so, you need to create a normal Buildroot configuration that builds a basic system for the hardware: toolchain, kernel, bootloader, filesystem and a simple BusyBox-only userspace. No specific package should be selected: the configuration should be as minimal as possible, and should only build a working basic BusyBox system for the target platform. You can of course use more complicated configurations for your internal projects, but the Buildroot project will only integrate basic board configurations. This is because package selections are highly application-specific. Once you have a known working configuration, run +make savedefconfig+. This will generate a minimal +defconfig+ file at the root of the Buildroot source tree. Move this file into the +configs/+ directory, and rename it +<boardname>_defconfig+. It is recommended to use as much as possible upstream versions of the Linux kernel and bootloaders, and to use as much as possible default kernel and bootloader configurations. If they are incorrect for your board, or no default exists, we encourage you to send fixes to the corresponding upstream projects. However, in the mean time, you may want to store kernel or bootloader configuration or patches specific to your target platform. To do so, create a directory +board/<manufacturer>+ and a subdirectory +board/<manufacturer>/<boardname>+. You can then store your patches and configurations in these directories, and reference them from the main Buildroot configuration. Refer to xref:customize[] for more details.
shibajee/buildroot
docs/manual/adding-board-support.txt
Text
mit
1,898
// -*- mode:doc; -*- // vim: syntax=asciidoc === Infrastructure for asciidoc documents [[asciidoc-documents-tutorial]] The Buildroot manual, which you are currently reading, is entirely written using the http://asciidoc.org/[AsciiDoc] mark-up syntax. The manual is then rendered to many formats: * html * split-html * pdf * epub * text Although Buildroot only contains one document written in AsciiDoc, there is, as for packages, an infrastructure for rendering documents using the AsciiDoc syntax. Also as for packages, the AsciiDoc infrastructure is available from xref:outside-br-custom[BR2_EXTERNAL]. This allows documentation for a BR2_EXTERNAL tree to match the Buildroot documentation, as it will be rendered to the same formats and use the same layout and theme. ==== +asciidoc-document+ tutorial Whereas package infrastructures are suffixed with +-package+, the document infrastructures are suffixed with +-document+. So, the AsciiDoc infrastructure is named +asciidoc-document+. Here is an example to render a simple AsciiDoc document. ---- 01: ################################################################################ 02: # 03: # foo-document 04: # 05: ################################################################################ 06: 07: FOO_SOURCES = $(sort $(wildcard $(pkgdir)/*)) 08: $(eval $(call asciidoc-document)) ---- On line 7, the Makefile declares what the sources of the document are. Currently, it is expected that the document's sources are only local; Buildroot will not attempt to download anything to render a document. Thus, you must indicate where the sources are. Usually, the string above is sufficient for a document with no sub-directory structure. On line 8, we call the +asciidoc-document+ function, which generates all the Makefile code necessary to render the document. ==== +asciidoc-document+ reference The list of variables that can be set in a +.mk+ file to give metadata information is (assuming the document name is +foo+) : * +FOO_SOURCES+, mandatory, defines the source files for the document. * +FOO_RESOURCES+, optional, may contain a space-separated list of paths to one or more directories containing so-called resources (like CSS or images). By default, empty. There are also additional hooks (see xref:hooks[] for general information on hooks), that a document may set to define extra actions to be done at various steps: * +FOO_POST_RSYNC_HOOKS+ to run additional commands after the sources have been copied by Buildroot. This can for example be used to generate part of the manual with information extracted from the tree. As an example, Buildroot uses this hook to generate the tables in the appendices. * +FOO_CHECK_DEPENDENCIES_HOOKS+ to run additional tests on required components to generate the document. In AsciiDoc, it is possible to call filters, that is, programs that will parse an AsciiDoc block and render it appropriately (e.g. http://ditaa.sourceforge.net/[ditaa] or https://pythonhosted.org/aafigure/[aafigure]). * +FOO_CHECK_DEPENDENCIES_<FMT>_HOOKS+, to run additional tests for the specified format +<FMT>+ (see the list of rendered formats, above). Here is a complete example that uses all variables and all hooks: ---- 01: ################################################################################ 02: # 03: # foo-document 04: # 05: ################################################################################ 06: 07: FOO_SOURCES = $(sort $(wildcard $(pkgdir)/*)) 08: FOO_RESOURCES = $(sort $(wildcard $(pkgdir)/ressources)) 09: 10: define FOO_GEN_EXTRA_DOC 11: /path/to/generate-script --outdir=$(@D) 12: endef 13: FOO_POST_RSYNC_HOOKS += FOO_GEN_EXTRA_DOC 14: 15: define FOO_CHECK_MY_PROG 16: if ! which my-prog >/dev/null 2>&1; then \ 17: echo "You need my-prog to generate the foo document"; \ 18: exit 1; \ 19: fi 20: endef 21: FOO_CHECK_DEPENDENCIES_HOOKS += FOO_CHECK_MY_PROG 22: 23: define FOO_CHECK_MY_OTHER_PROG 24: if ! which my-other-prog >/dev/null 2>&1; then \ 25: echo "You need my-other-prog to generate the foo document as PDF"; \ 26: exit 1; \ 27: fi 28: endef 29: FOO_CHECK_DEPENDENCIES_PDF_HOOKS += FOO_CHECK_MY_OTHER_PROG 30: 31: $(eval $(call asciidoc-document)) ----
shibajee/buildroot
docs/manual/adding-packages-asciidoc.txt
Text
mit
4,283
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for autotools-based packages [[autotools-package-tutorial]] ==== +autotools-package+ tutorial First, let's see how to write a +.mk+ file for an autotools-based package, with an example : ------------------------ 01: ################################################################################ 02: # 03: # libfoo 04: # 05: ################################################################################ 06: 07: LIBFOO_VERSION = 1.0 08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz 09: LIBFOO_SITE = http://www.foosoftware.org/download 10: LIBFOO_INSTALL_STAGING = YES 11: LIBFOO_INSTALL_TARGET = NO 12: LIBFOO_CONF_OPTS = --disable-shared 13: LIBFOO_DEPENDENCIES = libglib2 host-pkgconf 14: 15: $(eval $(autotools-package)) ------------------------ On line 7, we declare the version of the package. On line 8 and 9, we declare the name of the tarball (xz-ed tarball recommended) and the location of the tarball on the Web. Buildroot will automatically download the tarball from this location. On line 10, we tell Buildroot to install the package to the staging directory. The staging directory, located in +output/staging/+ is the directory where all the packages are installed, including their development files, etc. By default, packages are not installed to the staging directory, since usually, only libraries need to be installed in the staging directory: their development files are needed to compile other libraries or applications depending on them. Also by default, when staging installation is enabled, packages are installed in this location using the +make install+ command. On line 11, we tell Buildroot to not install the package to the target directory. This directory contains what will become the root filesystem running on the target. For purely static libraries, it is not necessary to install them in the target directory because they will not be used at runtime. By default, target installation is enabled; setting this variable to NO is almost never needed. Also by default, packages are installed in this location using the +make install+ command. On line 12, we tell Buildroot to pass a custom configure option, that will be passed to the +./configure+ script before configuring and building the package. On line 13, we declare our dependencies, so that they are built before the build process of our package starts. Finally, on line line 15, we invoke the +autotools-package+ macro that generates all the Makefile rules that actually allows the package to be built. [[autotools-package-reference]] ==== +autotools-package+ reference The main macro of the autotools package infrastructure is +autotools-package+. It is similar to the +generic-package+ macro. The ability to have target and host packages is also available, with the +host-autotools-package+ macro. Just like the generic infrastructure, the autotools infrastructure works by defining a number of variables before calling the +autotools-package+ macro. First, all the package metadata information variables that exist in the generic infrastructure also exist in the autotools infrastructure: +LIBFOO_VERSION+, +LIBFOO_SOURCE+, +LIBFOO_PATCH+, +LIBFOO_SITE+, +LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+, +LIBFOO_INSTALL_STAGING+, +LIBFOO_INSTALL_TARGET+. A few additional variables, specific to the autotools infrastructure, can also be defined. Many of them are only useful in very specific cases, typical packages will therefore only use a few of them. * +LIBFOO_SUBDIR+ may contain the name of a subdirectory inside the package that contains the configure script. This is useful, if for example, the main configure script is not at the root of the tree extracted by the tarball. If +HOST_LIBFOO_SUBDIR+ is not specified, it defaults to +LIBFOO_SUBDIR+. * +LIBFOO_CONF_ENV+, to specify additional environment variables to pass to the configure script. By default, empty. * +LIBFOO_CONF_OPTS+, to specify additional configure options to pass to the configure script. By default, empty. * +LIBFOO_MAKE+, to specify an alternate +make+ command. This is typically useful when parallel make is enabled in the configuration (using +BR2_JLEVEL+) but that this feature should be disabled for the given package, for one reason or another. By default, set to +$(MAKE)+. If parallel building is not supported by the package, then it should be set to +LIBFOO_MAKE=$(MAKE1)+. * +LIBFOO_MAKE_ENV+, to specify additional environment variables to pass to make in the build step. These are passed before the +make+ command. By default, empty. * +LIBFOO_MAKE_OPTS+, to specify additional variables to pass to make in the build step. These are passed after the +make+ command. By default, empty. * +LIBFOO_AUTORECONF+, tells whether the package should be autoreconfigured or not (i.e. if the configure script and Makefile.in files should be re-generated by re-running autoconf, automake, libtool, etc.). Valid values are +YES+ and +NO+. By default, the value is +NO+ * +LIBFOO_AUTORECONF_ENV+, to specify additional environment variables to pass to the 'autoreconf' program if +LIBFOO_AUTORECONF=YES+. These are passed in the environment of the 'autoreconf' command. By default, empty. * +LIBFOO_AUTORECONF_OPTS+ to specify additional options passed to the 'autoreconf' program if +LIBFOO_AUTORECONF=YES+. By default, empty. * +LIBFOO_GETTEXTIZE+, tells whether the package should be gettextized or not (i.e. if the package uses a different gettext version than Buildroot provides, and it is needed to run 'gettextize'.) Only valid when +LIBFOO_AUTORECONF=YES+. Valid values are +YES+ and +NO+. The default is +NO+. * +LIBFOO_GETTEXTIZE_OPTS+, to specify additional options passed to the 'gettextize' program, if +LIBFOO_GETTEXTIZE=YES+. You may use that if, for example, the +.po+ files are not located in the standard place (i.e. in +po/+ at the root of the package.) By default, '-f'. * +LIBFOO_LIBTOOL_PATCH+ tells whether the Buildroot patch to fix libtool cross-compilation issues should be applied or not. Valid values are +YES+ and +NO+. By default, the value is +YES+ * +LIBFOO_INSTALL_STAGING_OPTS+ contains the make options used to install the package to the staging directory. By default, the value is +DESTDIR=$(STAGING_DIR) install+, which is correct for most autotools packages. It is still possible to override it. * +LIBFOO_INSTALL_TARGET_OPTS+ contains the make options used to install the package to the target directory. By default, the value is +DESTDIR=$(TARGET_DIR) install+. The default value is correct for most autotools packages, but it is still possible to override it if needed. With the autotools infrastructure, all the steps required to build and install the packages are already defined, and they generally work well for most autotools-based packages. However, when required, it is still possible to customize what is done in any particular step: * By adding a post-operation hook (after extract, patch, configure, build or install). See xref:hooks[] for details. * By overriding one of the steps. For example, even if the autotools infrastructure is used, if the package +.mk+ file defines its own +LIBFOO_CONFIGURE_CMDS+ variable, it will be used instead of the default autotools one. However, using this method should be restricted to very specific cases. Do not use it in the general case.
shibajee/buildroot
docs/manual/adding-packages-autotools.txt
Text
mit
7,503
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for CMake-based packages [[cmake-package-tutorial]] ==== +cmake-package+ tutorial First, let's see how to write a +.mk+ file for a CMake-based package, with an example : ------------------------ 01: ################################################################################ 02: # 03: # libfoo 04: # 05: ################################################################################ 06: 07: LIBFOO_VERSION = 1.0 08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz 09: LIBFOO_SITE = http://www.foosoftware.org/download 10: LIBFOO_INSTALL_STAGING = YES 11: LIBFOO_INSTALL_TARGET = NO 12: LIBFOO_CONF_OPTS = -DBUILD_DEMOS=ON 13: LIBFOO_DEPENDENCIES = libglib2 host-pkgconf 14: 15: $(eval $(cmake-package)) ------------------------ On line 7, we declare the version of the package. On line 8 and 9, we declare the name of the tarball (xz-ed tarball recommended) and the location of the tarball on the Web. Buildroot will automatically download the tarball from this location. On line 10, we tell Buildroot to install the package to the staging directory. The staging directory, located in +output/staging/+ is the directory where all the packages are installed, including their development files, etc. By default, packages are not installed to the staging directory, since usually, only libraries need to be installed in the staging directory: their development files are needed to compile other libraries or applications depending on them. Also by default, when staging installation is enabled, packages are installed in this location using the +make install+ command. On line 11, we tell Buildroot to not install the package to the target directory. This directory contains what will become the root filesystem running on the target. For purely static libraries, it is not necessary to install them in the target directory because they will not be used at runtime. By default, target installation is enabled; setting this variable to NO is almost never needed. Also by default, packages are installed in this location using the +make install+ command. On line 12, we tell Buildroot to pass custom options to CMake when it is configuring the package. On line 13, we declare our dependencies, so that they are built before the build process of our package starts. Finally, on line line 15, we invoke the +cmake-package+ macro that generates all the Makefile rules that actually allows the package to be built. [[cmake-package-reference]] ==== +cmake-package+ reference The main macro of the CMake package infrastructure is +cmake-package+. It is similar to the +generic-package+ macro. The ability to have target and host packages is also available, with the +host-cmake-package+ macro. Just like the generic infrastructure, the CMake infrastructure works by defining a number of variables before calling the +cmake-package+ macro. First, all the package metadata information variables that exist in the generic infrastructure also exist in the CMake infrastructure: +LIBFOO_VERSION+, +LIBFOO_SOURCE+, +LIBFOO_PATCH+, +LIBFOO_SITE+, +LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+, +LIBFOO_INSTALL_STAGING+, +LIBFOO_INSTALL_TARGET+. A few additional variables, specific to the CMake infrastructure, can also be defined. Many of them are only useful in very specific cases, typical packages will therefore only use a few of them. * +LIBFOO_SUBDIR+ may contain the name of a subdirectory inside the package that contains the main CMakeLists.txt file. This is useful, if for example, the main CMakeLists.txt file is not at the root of the tree extracted by the tarball. If +HOST_LIBFOO_SUBDIR+ is not specified, it defaults to +LIBFOO_SUBDIR+. * +LIBFOO_CONF_ENV+, to specify additional environment variables to pass to CMake. By default, empty. * +LIBFOO_CONF_OPTS+, to specify additional configure options to pass to CMake. By default, empty. A number of common CMake options are set by the +cmake-package+ infrastructure; so it is normally not necessary to set them in the package's +*.mk+ file unless you want to override them: ** +CMAKE_BUILD_TYPE+ is driven by +BR2_ENABLE_DEBUG+; ** +CMAKE_INSTALL_PREFIX+; ** +BUILD_SHARED_LIBS+ is driven by +BR2_STATIC_LIBS+; ** +BUILD_DOC+, +BUILD_DOCS+ are disabled; ** +BUILD_EXAMPLE+, +BUILD_EXAMPLES+ are disabled; ** +BUILD_TEST+, +BUILD_TESTS+, +BUILD_TESTING+ are disabled. * +LIBFOO_SUPPORTS_IN_SOURCE_BUILD = NO+ should be set when the package cannot be built inside the source tree but needs a separate build directory. * +LIBFOO_MAKE+, to specify an alternate +make+ command. This is typically useful when parallel make is enabled in the configuration (using +BR2_JLEVEL+) but that this feature should be disabled for the given package, for one reason or another. By default, set to +$(MAKE)+. If parallel building is not supported by the package, then it should be set to +LIBFOO_MAKE=$(MAKE1)+. * +LIBFOO_MAKE_ENV+, to specify additional environment variables to pass to make in the build step. These are passed before the +make+ command. By default, empty. * +LIBFOO_MAKE_OPTS+, to specify additional variables to pass to make in the build step. These are passed after the +make+ command. By default, empty. * +LIBFOO_INSTALL_STAGING_OPTS+ contains the make options used to install the package to the staging directory. By default, the value is +DESTDIR=$(STAGING_DIR) install+, which is correct for most CMake packages. It is still possible to override it. * +LIBFOO_INSTALL_TARGET_OPTS+ contains the make options used to install the package to the target directory. By default, the value is +DESTDIR=$(TARGET_DIR) install+. The default value is correct for most CMake packages, but it is still possible to override it if needed. With the CMake infrastructure, all the steps required to build and install the packages are already defined, and they generally work well for most CMake-based packages. However, when required, it is still possible to customize what is done in any particular step: * By adding a post-operation hook (after extract, patch, configure, build or install). See xref:hooks[] for details. * By overriding one of the steps. For example, even if the CMake infrastructure is used, if the package +.mk+ file defines its own +LIBFOO_CONFIGURE_CMDS+ variable, it will be used instead of the default CMake one. However, using this method should be restricted to very specific cases. Do not use it in the general case.
shibajee/buildroot
docs/manual/adding-packages-cmake.txt
Text
mit
6,547
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Conclusion As you can see, adding a software package to Buildroot is simply a matter of writing a Makefile using an existing example and modifying it according to the compilation process required by the package. If you package software that might be useful for other people, don't forget to send a patch to the Buildroot mailing list (see xref:submitting-patches[])!
shibajee/buildroot
docs/manual/adding-packages-conclusion.txt
Text
mit
425
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Package directory First of all, create a directory under the +package+ directory for your software, for example +libfoo+. Some packages have been grouped by topic in a sub-directory: +x11r7+, +efl+ and +matchbox+. If your package fits in one of these categories, then create your package directory in these. New subdirectories are discouraged, however. === Config files For the package to be displayed in the configuration tool, you need to create a Config file in your package directory. There are two types: +Config.in+ and +Config.in.host+. ==== +Config.in+ file For packages used on the target, create a file named +Config.in+. This file will contain the option descriptions related to our +libfoo+ software that will be used and displayed in the configuration tool. It should basically contain: --------------------------- config BR2_PACKAGE_LIBFOO bool "libfoo" help This is a comment that explains what libfoo is. http://foosoftware.org/libfoo/ --------------------------- The +bool+ line, +help+ line and other metadata information about the configuration option must be indented with one tab. The help text itself should be indented with one tab and two spaces, lines should not be longer than 72 columns, and it must mention the upstream URL of the project. As a convention specific to Buildroot, the ordering of the attributes is as follows: 1. The type of option: +bool+, +string+... with the prompt 2. If needed, the +default+ value(s) 3. Any dependency of the +depends on+ form 4. Any dependency of the +select+ form 5. The help keyword and help text. You can add other sub-options into a +if BR2_PACKAGE_LIBFOO...endif+ statement to configure particular things in your software. You can look at examples in other packages. The syntax of the +Config.in+ file is the same as the one for the kernel Kconfig file. The documentation for this syntax is available at http://kernel.org/doc/Documentation/kbuild/kconfig-language.txt[] Finally you have to add your new +libfoo/Config.in+ to +package/Config.in+ (or in a category subdirectory if you decided to put your package in one of the existing categories). The files included there are 'sorted alphabetically' per category and are 'NOT' supposed to contain anything but the 'bare' name of the package. -------------------------- source "package/libfoo/Config.in" -------------------------- ==== +Config.in.host+ file Some packages also need to be built for the host system. There are two options here: * The host package is only required to satisfy build-time dependencies of one or more target packages. In this case, add +host-foo+ to the target package's +BAR_DEPENDENCIES+ variable. No +Config.in.host+ file should be created. * The host package should be explicitly selectable by the user from the configuration menu. In this case, create a +Config.in.host+ file for that host package: + --------------------------- config BR2_PACKAGE_HOST_FOO bool "host foo" help This is a comment that explains what foo for the host is. http://foosoftware.org/foo/ --------------------------- + The same coding style and options as for the +Config.in+ file are valid. + Finally you have to add your new +libfoo/Config.in.host+ to +package/Config.in.host+. The files included there are 'sorted alphabetically' and are 'NOT' supposed to contain anything but the 'bare' name of the package. + -------------------------- source "package/foo/Config.in.host" -------------------------- + The host package will then be available from the +Host utilities+ menu. [[depends-on-vs-select]] ==== Choosing +depends on+ or +select+ The +Config.in+ file of your package must also ensure that dependencies are enabled. Typically, Buildroot uses the following rules: * Use a +select+ type of dependency for dependencies on libraries. These dependencies are generally not obvious and it therefore make sense to have the kconfig system ensure that the dependencies are selected. For example, the _libgtk2_ package uses +select BR2_PACKAGE_LIBGLIB2+ to make sure this library is also enabled. The +select+ keyword expresses the dependency with a backward semantic. * Use a +depends on+ type of dependency when the user really needs to be aware of the dependency. Typically, Buildroot uses this type of dependency for dependencies on target architecture, MMU support and toolchain options (see xref:dependencies-target-toolchain-options[]), or for dependencies on "big" things, such as the X.org system. The +depends on+ keyword expresses the dependency with a forward semantic. .Note The current problem with the _kconfig_ language is that these two dependency semantics are not internally linked. Therefore, it may be possible to select a package, whom one of its dependencies/requirement is not met. An example illustrates both the usage of +select+ and +depends on+. -------------------------- config BR2_PACKAGE_RRDTOOL bool "rrdtool" depends on BR2_USE_WCHAR select BR2_PACKAGE_FREETYPE select BR2_PACKAGE_LIBART select BR2_PACKAGE_LIBPNG select BR2_PACKAGE_ZLIB help RRDtool is the OpenSource industry standard, high performance data logging and graphing system for time series data. http://oss.oetiker.ch/rrdtool/ comment "rrdtool needs a toolchain w/ wchar" depends on !BR2_USE_WCHAR -------------------------- Note that these two dependency types are only transitive with the dependencies of the same kind. This means, in the following example: -------------------------- config BR2_PACKAGE_A bool "Package A" config BR2_PACKAGE_B bool "Package B" depends on BR2_PACKAGE_A config BR2_PACKAGE_C bool "Package C" depends on BR2_PACKAGE_B config BR2_PACKAGE_D bool "Package D" select BR2_PACKAGE_B config BR2_PACKAGE_E bool "Package E" select BR2_PACKAGE_D -------------------------- * Selecting +Package C+ will be visible if +Package B+ has been selected, which in turn is only visible if +Package A+ has been selected. * Selecting +Package E+ will select +Package D+, which will select +Package B+, it will not check for the dependencies of +Package B+, so it will not select +Package A+. * Since +Package B+ is selected but +Package A+ is not, this violates the dependency of +Package B+ on +Package A+. Therefore, in such a situation, the transitive dependency has to be added explicitly: -------------------------- config BR2_PACKAGE_D bool "Package D" select BR2_PACKAGE_B depends on BR2_PACKAGE_A config BR2_PACKAGE_E bool "Package E" select BR2_PACKAGE_D depends on BR2_PACKAGE_A -------------------------- Overall, for package library dependencies, +select+ should be preferred. Note that such dependencies will ensure that the dependency option is also enabled, but not necessarily built before your package. To do so, the dependency also needs to be expressed in the +.mk+ file of the package. Further formatting details: see xref:writing-rules-config-in[the coding style]. [[dependencies-target-toolchain-options]] ==== Dependencies on target and toolchain options Many packages depend on certain options of the toolchain: the choice of C library, C++ support, thread support, RPC support, wchar support, or dynamic library support. Some packages can only be built on certain target architectures, or if an MMU is available in the processor. These dependencies have to be expressed with the appropriate 'depends on' statements in the Config.in file. Additionally, for dependencies on toolchain options, a +comment+ should be displayed when the option is not enabled, so that the user knows why the package is not available. Dependencies on target architecture or MMU support should not be made visible in a comment: since it is unlikely that the user can freely choose another target, it makes little sense to show these dependencies explicitly. The +comment+ should only be visible if the +config+ option itself would be visible when the toolchain option dependencies are met. This means that all other dependencies of the package (including dependencies on target architecture and MMU support) have to be repeated on the +comment+ definition. To keep it clear, the +depends on+ statement for these non-toolchain option should be kept separate from the +depends on+ statement for the toolchain options. If there is a dependency on a config option in that same file (typically the main package) it is preferable to have a global +if ... endif+ construct rather than repeating the +depends on+ statement on the comment and other config options. The general format of a dependency +comment+ for package foo is: -------------------------- foo needs a toolchain w/ featA, featB, featC -------------------------- for example: -------------------------- mpd needs a toolchain w/ C++, threads, wchar -------------------------- or -------------------------- crda needs a toolchain w/ threads -------------------------- Note that this text is kept brief on purpose, so that it will fit on a 80-character terminal. The rest of this section enumerates the different target and toolchain options, the corresponding config symbols to depend on, and the text to use in the comment. * Target architecture ** Dependency symbol: +BR2_powerpc+, +BR2_mips+, ... (see +arch/Config.in+) ** Comment string: no comment to be added * MMU support ** Dependency symbol: +BR2_USE_MMU+ ** Comment string: no comment to be added * Gcc +__sync_*+ built-ins used for atomic operations. They are available in variants operating on 1 byte, 2 bytes, 4 bytes and 8 bytes. Since different architectures support atomic operations on different sizes, one dependency symbol is available for each size: ** Dependency symbol: +BR2_TOOLCHAIN_HAS_SYNC_1+ for 1 byte, +BR2_TOOLCHAIN_HAS_SYNC_2+ for 2 bytes, +BR2_TOOLCHAIN_HAS_SYNC_4+ for 4 bytes, +BR2_TOOLCHAIN_HAS_SYNC_8+ for 8 bytes. ** Comment string: no comment to be added * Gcc +__atomic_*+ built-ins used for atomic operations. ** Dependency symbol: +BR2_TOOLCHAIN_HAS_ATOMIC+. ** Comment string: no comment to be added * Kernel headers ** Dependency symbol: +BR2_TOOLCHAIN_HEADERS_AT_LEAST_X_Y+, (replace +X_Y+ with the proper version, see +toolchain/toolchain-common.in+) ** Comment string: +headers >= X.Y+ and/or `headers <= X.Y` (replace +X.Y+ with the proper version) * GCC version ** Dependency symbol: +BR2_TOOLCHAIN_GCC_AT_LEAST_X_Y+, (replace +X_Y+ with the proper version, see +toolchain/toolchain-common.in+) ** Comment string: +gcc >= X.Y+ and/or `gcc <= X.Y` (replace +X.Y+ with the proper version) * Host GCC version ** Dependency symbol: +BR2_HOST_GCC_AT_LEAST_X_Y+, (replace +X_Y+ with the proper version, see +Config.in+) ** Comment string: no comment to be added ** Note that it is usually not the package itself that has a minimum host GCC version, but rather a host-package on which it depends. * C library ** Dependency symbol: +BR2_TOOLCHAIN_USES_GLIBC+, +BR2_TOOLCHAIN_USES_MUSL+, +BR2_TOOLCHAIN_USES_UCLIBC+ ** Comment string: for the C library, a slightly different comment text is used: +foo needs a glibc toolchain+, or `foo needs a glibc toolchain w/ C++` * C++ support ** Dependency symbol: +BR2_INSTALL_LIBSTDCPP+ ** Comment string: `C++` * Fortran support ** Dependency symbol: +BR2_TOOLCHAIN_HAS_FORTRAN+ ** Comment string: `fortran` * thread support ** Dependency symbol: +BR2_TOOLCHAIN_HAS_THREADS+ ** Comment string: +threads+ (unless +BR2_TOOLCHAIN_HAS_THREADS_NPTL+ is also needed, in which case, specifying only +NPTL+ is sufficient) * NPTL thread support ** Dependency symbol: +BR2_TOOLCHAIN_HAS_THREADS_NPTL+ ** Comment string: +NPTL+ * RPC support ** Dependency symbol: +BR2_TOOLCHAIN_HAS_NATIVE_RPC+ ** Comment string: +RPC+ * wchar support ** Dependency symbol: +BR2_USE_WCHAR+ ** Comment string: +wchar+ * dynamic library ** Dependency symbol: +!BR2_STATIC_LIBS+ ** Comment string: +dynamic library+ ==== Dependencies on a Linux kernel built by buildroot Some packages need a Linux kernel to be built by buildroot. These are typically kernel modules or firmware. A comment should be added in the Config.in file to express this dependency, similar to dependencies on toolchain options. The general format is: -------------------------- foo needs a Linux kernel to be built -------------------------- If there is a dependency on both toolchain options and the Linux kernel, use this format: -------------------------- foo needs a toolchain w/ featA, featB, featC and a Linux kernel to be built -------------------------- ==== Dependencies on udev /dev management If a package needs udev /dev management, it should depend on symbol +BR2_PACKAGE_HAS_UDEV+, and the following comment should be added: -------------------------- foo needs udev /dev management -------------------------- If there is a dependency on both toolchain options and udev /dev management, use this format: -------------------------- foo needs udev /dev management and a toolchain w/ featA, featB, featC -------------------------- ==== Dependencies on features provided by virtual packages Some features can be provided by more than one package, such as the openGL libraries. See xref:virtual-package-tutorial[] for more on the virtual packages. See xref:virtual-package-list[] for the symbols to depend on if your package depends on a feature provided by a virtual package. === The +.mk+ file [[adding-packages-mk]] Finally, here's the hardest part. Create a file named +libfoo.mk+. It describes how the package should be downloaded, configured, built, installed, etc. Depending on the package type, the +.mk+ file must be written in a different way, using different infrastructures: * *Makefiles for generic packages* (not using autotools or CMake): These are based on an infrastructure similar to the one used for autotools-based packages, but require a little more work from the developer. They specify what should be done for the configuration, compilation and installation of the package. This infrastructure must be used for all packages that do not use the autotools as their build system. In the future, other specialized infrastructures might be written for other build systems. We cover them through in a xref:generic-package-tutorial[tutorial] and a xref:generic-package-reference[reference]. * *Makefiles for autotools-based software* (autoconf, automake, etc.): We provide a dedicated infrastructure for such packages, since autotools is a very common build system. This infrastructure 'must' be used for new packages that rely on the autotools as their build system. We cover them through a xref:autotools-package-tutorial[tutorial] and xref:autotools-package-reference[reference]. * *Makefiles for cmake-based software*: We provide a dedicated infrastructure for such packages, as CMake is a more and more commonly used build system and has a standardized behaviour. This infrastructure 'must' be used for new packages that rely on CMake. We cover them through a xref:cmake-package-tutorial[tutorial] and xref:cmake-package-reference[reference]. * *Makefiles for Python modules*: We have a dedicated infrastructure for Python modules that use either the +distutils+ or the +setuptools+ mechanism. We cover them through a xref:python-package-tutorial[tutorial] and a xref:python-package-reference[reference]. * *Makefiles for Lua modules*: We have a dedicated infrastructure for Lua modules available through the LuaRocks web site. We cover them through a xref:luarocks-package-tutorial[tutorial] and a xref:luarocks-package-reference[reference]. Further formatting details: see xref:writing-rules-mk[the writing rules]. [[adding-packages-hash]] === The +.hash+ file Optionally, you can add a third file, named +libfoo.hash+, that contains the hashes of the downloaded files for the +libfoo+ package. The hashes stored in that file are used to validate the integrity of the downloaded files. The format of this file is one line for each file for which to check the hash, each line being space-separated, with these three fields: * the type of hash, one of: ** +md5+, +sha1+, +sha224+, +sha256+, +sha384+, +sha512+, +none+ * the hash of the file: ** for +none+, one or more non-space chars, usually just the string +xxx+ ** for +md5+, 32 hexadecimal characters ** for +sha1+, 40 hexadecimal characters ** for +sha224+, 56 hexadecimal characters ** for +sha256+, 64 hexadecimal characters ** for +sha384+, 96 hexadecimal characters ** for +sha512+, 128 hexadecimal characters * the name of the file, without any directory component Lines starting with a +#+ sign are considered comments, and ignored. Empty lines are ignored. There can be more than one hash for a single file, each on its own line. In this case, all hashes must match. .Note Ideally, the hashes stored in this file should match the hashes published by upstream, e.g. on their website, in the e-mail announcement... If upstream provides more than one type of hash (e.g. +sha1+ and +sha512+), then it is best to add all those hashes in the +.hash+ file. If upstream does not provide any hash, or only provides an +md5+ hash, then compute at least one strong hash yourself (preferably +sha256+, but not +md5+), and mention this in a comment line above the hashes. .Note The number of spaces does not matter, so one can use spaces (or tabs) to properly align the different fields. The +none+ hash type is reserved to those archives downloaded from a repository, like a 'git clone', a 'subversion checkout'... The example below defines a +sha1+ and a +sha256+ published by upstream for the main +libfoo-1.2.3.tar.bz2+ tarball, an +md5+ from upstream and a locally-computed +sha256+ hashes for a binary blob, a +sha256+ for a downloaded patch, and an archive with no hash: ---- # Hashes from: http://www.foosoftware.org/download/libfoo-1.2.3.tar.bz2.{sha1,sha256}: sha1 486fb55c3efa71148fe07895fd713ea3a5ae343a libfoo-1.2.3.tar.bz2 sha256 efc8103cc3bcb06bda6a781532d12701eb081ad83e8f90004b39ab81b65d4369 libfoo-1.2.3.tar.bz2 # md5 from: http://www.foosoftware.org/download/libfoo-1.2.3.tar.bz2.md5, sha256 locally computed: md5 2d608f3c318c6b7557d551a5a09314f03452f1a1 libfoo-data.bin sha256 01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b libfoo-data.bin # Locally computed: sha256 ff52101fb90bbfc3fe9475e425688c660f46216d7e751c4bbdb1dc85cdccacb9 libfoo-fix-blabla.patch # No hash for 1234: none xxx libfoo-1234.tar.gz ---- If the +.hash+ file is present, and it contains one or more hashes for a downloaded file, the hash(es) computed by Buildroot (after download) must match the hash(es) stored in the +.hash+ file. If one or more hashes do not match, Buildroot considers this an error, deletes the downloaded file, and aborts. If the +.hash+ file is present, but it does not contain a hash for a downloaded file, Buildroot considers this an error and aborts. However, the downloaded file is left in the download directory since this typically indicates that the +.hash+ file is wrong but the downloaded file is probably OK. Sources that are downloaded from a version control system (git, subversion, etc...) can not have a hash, because the version control system and tar may not create exactly the same file (dates, files ordering...), so the hash could be wrong even for a valid download. Therefore, the hash check is entirely skipped for such sources. If the +.hash+ file is missing, then no check is done at all.
shibajee/buildroot
docs/manual/adding-packages-directory.txt
Text
mit
19,752
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for packages with specific build systems By 'packages with specific build systems' we mean all the packages whose build system is not one of the standard ones, such as 'autotools' or 'CMake'. This typically includes packages whose build system is based on hand-written Makefiles or shell scripts. [[generic-package-tutorial]] ==== +generic-package+ tutorial ------------------------------ 01: ################################################################################ 02: # 03: # libfoo 04: # 05: ################################################################################ 06: 07: LIBFOO_VERSION = 1.0 08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz 09: LIBFOO_SITE = http://www.foosoftware.org/download 10: LIBFOO_LICENSE = GPLv3+ 11: LIBFOO_LICENSE_FILES = COPYING 12: LIBFOO_INSTALL_STAGING = YES 13: LIBFOO_CONFIG_SCRIPTS = libfoo-config 14: LIBFOO_DEPENDENCIES = host-libaaa libbbb 15: 16: define LIBFOO_BUILD_CMDS 17: $(MAKE) $(TARGET_CONFIGURE_OPTS) -C $(@D) all 18: endef 19: 20: define LIBFOO_INSTALL_STAGING_CMDS 21: $(INSTALL) -D -m 0755 $(@D)/libfoo.a $(STAGING_DIR)/usr/lib/libfoo.a 22: $(INSTALL) -D -m 0644 $(@D)/foo.h $(STAGING_DIR)/usr/include/foo.h 23: $(INSTALL) -D -m 0755 $(@D)/libfoo.so* $(STAGING_DIR)/usr/lib 24: endef 25: 26: define LIBFOO_INSTALL_TARGET_CMDS 27: $(INSTALL) -D -m 0755 $(@D)/libfoo.so* $(TARGET_DIR)/usr/lib 28: $(INSTALL) -d -m 0755 $(TARGET_DIR)/etc/foo.d 29: endef 30: 31: define LIBFOO_USERS 32: foo -1 libfoo -1 * - - - LibFoo daemon 33: endef 34: 35: define LIBFOO_DEVICES 36: /dev/foo c 666 0 0 42 0 - - - 37: endef 38: 39: define LIBFOO_PERMISSIONS 40: /bin/foo f 4755 foo libfoo - - - - - 41: endef 42: 43: $(eval $(generic-package)) -------------------------------- The Makefile begins on line 7 to 11 with metadata information: the version of the package (+LIBFOO_VERSION+), the name of the tarball containing the package (+LIBFOO_SOURCE+) (xz-ed tarball recommended) the Internet location at which the tarball can be downloaded from (+LIBFOO_SITE+), the license (+LIBFOO_LICENSE+) and file with the license text (+LIBFOO_LICENSE_FILES+). All variables must start with the same prefix, +LIBFOO_+ in this case. This prefix is always the uppercased version of the package name (see below to understand where the package name is defined). On line 12, we specify that this package wants to install something to the staging space. This is often needed for libraries, since they must install header files and other development files in the staging space. This will ensure that the commands listed in the +LIBFOO_INSTALL_STAGING_CMDS+ variable will be executed. On line 13, we specify that there is some fixing to be done to some of the 'libfoo-config' files that were installed during +LIBFOO_INSTALL_STAGING_CMDS+ phase. These *-config files are executable shell script files that are located in '$(STAGING_DIR)/usr/bin' directory and are executed by other 3rd party packages to find out the location and the linking flags of this particular package. The problem is that all these *-config files by default give wrong, host system linking flags that are unsuitable for cross-compiling. For example: '-I/usr/include' instead of '-I$(STAGING_DIR)/usr/include' or: '-L/usr/lib' instead of '-L$(STAGING_DIR)/usr/lib' So some sed magic is done to these scripts to make them give correct flags. The argument to be given to +LIBFOO_CONFIG_SCRIPTS+ is the file name(s) of the shell script(s) needing fixing. All these names are relative to '$(STAGING_DIR)/usr/bin' and if needed multiple names can be given. In addition, the scripts listed in +LIBFOO_CONFIG_SCRIPTS+ are removed from +$(TARGET_DIR)/usr/bin+, since they are not needed on the target. .Config script: 'divine' package ================================ Package divine installs shell script '$(STAGING_DIR)/usr/bin/divine-config'. So its fixup would be: -------------------------------- DIVINE_CONFIG_SCRIPTS = divine-config -------------------------------- ================================ .Config script: 'imagemagick' package: ================================ Package imagemagick installs the following scripts: '$(STAGING_DIR)/usr/bin/{Magick,Magick++,MagickCore,MagickWand,Wand}-config' So it's fixup would be: -------------------------------- IMAGEMAGICK_CONFIG_SCRIPTS = \ Magick-config Magick++-config \ MagickCore-config MagickWand-config Wand-config -------------------------------- ================================ On line 14, we specify the list of dependencies this package relies on. These dependencies are listed in terms of lower-case package names, which can be packages for the target (without the +host-+ prefix) or packages for the host (with the +host-+) prefix). Buildroot will ensure that all these packages are built and installed 'before' the current package starts its configuration. The rest of the Makefile, lines 16..29, defines what should be done at the different steps of the package configuration, compilation and installation. +LIBFOO_BUILD_CMDS+ tells what steps should be performed to build the package. +LIBFOO_INSTALL_STAGING_CMDS+ tells what steps should be performed to install the package in the staging space. +LIBFOO_INSTALL_TARGET_CMDS+ tells what steps should be performed to install the package in the target space. All these steps rely on the +$(@D)+ variable, which contains the directory where the source code of the package has been extracted. On lines 31..43, we define a user that is used by this package (e.g. to run a daemon as non-root) (+LIBFOO_USERS+). On line 35..37, we define a device-node file used by this package (+LIBFOO_DEVICES+). On line 39..41, we define the permissions to set to specific files installed by this package (+LIBFOO_PERMISSIONS+). Finally, on line 43, we call the +generic-package+ function, which generates, according to the variables defined previously, all the Makefile code necessary to make your package working. [[generic-package-reference]] ==== +generic-package+ reference There are two variants of the generic target. The +generic-package+ macro is used for packages to be cross-compiled for the target. The +host-generic-package+ macro is used for host packages, natively compiled for the host. It is possible to call both of them in a single +.mk+ file: once to create the rules to generate a target package and once to create the rules to generate a host package: ---------------------- $(eval $(generic-package)) $(eval $(host-generic-package)) ---------------------- This might be useful if the compilation of the target package requires some tools to be installed on the host. If the package name is +libfoo+, then the name of the package for the target is also +libfoo+, while the name of the package for the host is +host-libfoo+. These names should be used in the DEPENDENCIES variables of other packages, if they depend on +libfoo+ or +host-libfoo+. The call to the +generic-package+ and/or +host-generic-package+ macro *must* be at the end of the +.mk+ file, after all variable definitions. For the target package, the +generic-package+ uses the variables defined by the .mk file and prefixed by the uppercased package name: +LIBFOO_*+. +host-generic-package+ uses the +HOST_LIBFOO_*+ variables. For 'some' variables, if the +HOST_LIBFOO_+ prefixed variable doesn't exist, the package infrastructure uses the corresponding variable prefixed by +LIBFOO_+. This is done for variables that are likely to have the same value for both the target and host packages. See below for details. The list of variables that can be set in a +.mk+ file to give metadata information is (assuming the package name is +libfoo+) : * +LIBFOO_VERSION+, mandatory, must contain the version of the package. Note that if +HOST_LIBFOO_VERSION+ doesn't exist, it is assumed to be the same as +LIBFOO_VERSION+. It can also be a revision number, branch or tag for packages that are fetched directly from their revision control system. + Examples: + +LIBFOO_VERSION = 0.1.2+ + +LIBFOO_VERSION = cb9d6aa9429e838f0e54faa3d455bcbab5eef057+ + +LIBFOO_VERSION = stable+ * +LIBFOO_SOURCE+ may contain the name of the tarball of the package, which Buildroot will use to download the tarball from +LIBFOO_SITE+. If +HOST_LIBFOO_SOURCE+ is not specified, it defaults to +LIBFOO_SOURCE+. If none are specified, then the value is assumed to be +libfoo-$(LIBFOO_VERSION).tar.gz+. + Example: +LIBFOO_SOURCE = foobar-$(LIBFOO_VERSION).tar.bz2+ * +LIBFOO_PATCH+ may contain a space-separated list of patch file names, that Buildroot will download and apply to the package source code. If an entry contains +://+, then Buildroot will assume it is a full URL and download the patch from this location. Otherwise, Buildroot will assume that the patch should be downloaded from +LIBFOO_SITE+. If +HOST_LIBFOO_PATCH+ is not specified, it defaults to +LIBFOO_PATCH+. Note that patches that are included in Buildroot itself use a different mechanism: all files of the form +*.patch+ present in the package directory inside Buildroot will be applied to the package after extraction (see xref:patch-policy[patching a package]). Finally, patches listed in the +LIBFOO_PATCH+ variable are applied _before_ the patches stored in the Buildroot package directory. * +LIBFOO_SITE+ provides the location of the package, which can be a URL or a local filesystem path. HTTP, FTP and SCP are supported URL types for retrieving package tarballs. In these cases don't include a trailing slash: it will be added by Buildroot between the directory and the filename as appropriate. Git, Subversion, Mercurial, and Bazaar are supported URL types for retrieving packages directly from source code management systems. There is a helper function to make it easier to download source tarballs from GitHub (refer to xref:github-download-url[] for details). A filesystem path may be used to specify either a tarball or a directory containing the package source code. See +LIBFOO_SITE_METHOD+ below for more details on how retrieval works. + Note that SCP URLs should be of the form +scp://[user@]host:filepath+, and that filepath is relative to the user's home directory, so you may want to prepend the path with a slash for absolute paths: +scp://[user@]host:/absolutepath+. + If +HOST_LIBFOO_SITE+ is not specified, it defaults to +LIBFOO_SITE+. Examples: + +LIBFOO_SITE=http://www.libfoosoftware.org/libfoo+ + +LIBFOO_SITE=http://svn.xiph.org/trunk/Tremor+ + +LIBFOO_SITE=/opt/software/libfoo.tar.gz+ + +LIBFOO_SITE=$(TOPDIR)/../src/libfoo+ * +LIBFOO_EXTRA_DOWNLOADS+ is a space-separated list of additional files that Buildroot should download. If an entry contains +://+ then Buildroot will assume it is a complete URL and will download the file using this URL. Otherwise, Buildroot will assume the file to be downloaded is located at +LIBFOO_SITE+. Buildroot will not do anything with those additional files, except download them: it will be up to the package recipe to use them from +$(BR2_DL_DIR)+. * +LIBFOO_SITE_METHOD+ determines the method used to fetch or copy the package source code. In many cases, Buildroot guesses the method from the contents of +LIBFOO_SITE+ and setting +LIBFOO_SITE_METHOD+ is unnecessary. When +HOST_LIBFOO_SITE_METHOD+ is not specified, it defaults to the value of +LIBFOO_SITE_METHOD+. + The possible values of +LIBFOO_SITE_METHOD+ are: ** +wget+ for normal FTP/HTTP downloads of tarballs. Used by default when +LIBFOO_SITE+ begins with +http://+, +https://+ or +ftp://+. ** +scp+ for downloads of tarballs over SSH with scp. Used by default when +LIBFOO_SITE+ begins with +scp://+. ** +svn+ for retrieving source code from a Subversion repository. Used by default when +LIBFOO_SITE+ begins with +svn://+. When a +http://+ Subversion repository URL is specified in +LIBFOO_SITE+, one 'must' specify +LIBFOO_SITE_METHOD=svn+. Buildroot performs a checkout which is preserved as a tarball in the download cache; subsequent builds use the tarball instead of performing another checkout. ** +cvs+ for retrieving source code from a CVS repository. Used by default when +LIBFOO_SITE+ begins with +cvs://+. The downloaded source code is cached as with the +svn+ method. Anonymous pserver mode is assumed otherwise explicitly defined on +LIBFOO_SITE+. Both +LIBFOO_SITE=cvs://libfoo.net:/cvsroot/libfoo+ and +LIBFOO_SITE=cvs://:ext:libfoo.net:/cvsroot/libfoo+ are accepted, on the former anonymous pserver access mode is assumed. +LIBFOO_SITE+ 'must' contain the source URL as well as the remote repository directory. The module is the package name. +LIBFOO_VERSION+ is 'mandatory' and 'must' be a tag, a branch, or a date (e.g. "2014-10-20", "2014-10-20 13:45", "2014-10-20 13:45+01" see "man cvs" for further details). ** +git+ for retrieving source code from a Git repository. Used by default when +LIBFOO_SITE+ begins with +git://+. The downloaded source code is cached as with the +svn+ method. ** +hg+ for retrieving source code from a Mercurial repository. One 'must' specify +LIBFOO_SITE_METHOD=hg+ when +LIBFOO_SITE+ contains a Mercurial repository URL. The downloaded source code is cached as with the +svn+ method. ** +bzr+ for retrieving source code from a Bazaar repository. Used by default when +LIBFOO_SITE+ begins with +bzr://+. The downloaded source code is cached as with the +svn+ method. ** +file+ for a local tarball. One should use this when +LIBFOO_SITE+ specifies a package tarball as a local filename. Useful for software that isn't available publicly or in version control. ** +local+ for a local source code directory. One should use this when +LIBFOO_SITE+ specifies a local directory path containing the package source code. Buildroot copies the contents of the source directory into the package's build directory. * +LIBFOO_GIT_SUBMODULES+, when +LIBFOO_SITE_METHOD=git+, will create an archive with the git submodules in the repository. Note that we try not to use such git submodules when they contain bundled libraries, in which case we prefer to use those libraries from their own package. * +LIBFOO_STRIP_COMPONENTS+ is the number of leading components (directories) that tar must strip from file names on extraction. The tarball for most packages has one leading component named "<pkg-name>-<pkg-version>", thus Buildroot passes --strip-components=1 to tar to remove it. For non-standard packages that don't have this component, or that have more than one leading component to strip, set this variable with the value to be passed to tar. Default: 1. * +LIBFOO_EXCLUDES+ is a space-separated list of patterns to exclude when extracting the archive. Each item from that list is passed as a tar's +--exclude+ option. By default, empty. * +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package name) that are required for the current target package to compile. These dependencies are guaranteed to be compiled and installed before the configuration of the current package starts. In a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for the current host package. * +LIBFOO_PATCH_DEPENDENCIES+ lists the dependencies (in terms of package name) that are required for the current package to be patched. These dependencies are guaranteed to be extracted and patched before the current package is patched. In a similar way, +HOST_LIBFOO_PATCH_DEPENDENCIES+ lists the dependencies for the current host package. This is seldom used; usually, +LIBFOO_DEPENDENCIES+ is what you really want to use. * +LIBFOO_PROVIDES+ lists all the virtual packages +libfoo+ is an implementation of. See xref:virtual-package-tutorial[]. * +LIBFOO_INSTALL_STAGING+ can be set to +YES+ or +NO+ (default). If set to +YES+, then the commands in the +LIBFOO_INSTALL_STAGING_CMDS+ variables are executed to install the package into the staging directory. * +LIBFOO_INSTALL_TARGET+ can be set to +YES+ (default) or +NO+. If set to +YES+, then the commands in the +LIBFOO_INSTALL_TARGET_CMDS+ variables are executed to install the package into the target directory. * +LIBFOO_INSTALL_IMAGES+ can be set to +YES+ or +NO+ (default). If set to +YES+, then the commands in the +LIBFOO_INSTALL_IMAGES_CMDS+ variable are executed to install the package into the images directory. * +LIBFOO_CONFIG_SCRIPTS+ lists the names of the files in '$(STAGING_DIR)/usr/bin' that need some special fixing to make them cross-compiling friendly. Multiple file names separated by space can be given and all are relative to '$(STAGING_DIR)/usr/bin'. The files listed in +LIBFOO_CONFIG_SCRIPTS+ are also removed from +$(TARGET_DIR)/usr/bin+ since they are not needed on the target. * +LIBFOO_DEVICES+ lists the device files to be created by Buildroot when using the static device table. The syntax to use is the makedevs one. You can find some documentation for this syntax in the xref:makedev-syntax[]. This variable is optional. * +LIBFOO_PERMISSIONS+ lists the changes of permissions to be done at the end of the build process. The syntax is once again the makedevs one. You can find some documentation for this syntax in the xref:makedev-syntax[]. This variable is optional. * +LIBFOO_USERS+ lists the users to create for this package, if it installs a program you want to run as a specific user (e.g. as a daemon, or as a cron-job). The syntax is similar in spirit to the makedevs one, and is described in the xref:makeuser-syntax[]. This variable is optional. * +LIBFOO_LICENSE+ defines the license (or licenses) under which the package is released. This name will appear in the manifest file produced by +make legal-info+. If the license appears in xref:legal-info-list-licenses[the following list], use the same string to make the manifest file uniform. Otherwise, describe the license in a precise and concise way, avoiding ambiguous names such as +BSD+ which actually name a family of licenses. This variable is optional. If it is not defined, +unknown+ will appear in the +license+ field of the manifest file for this package. + The expected format for this variable must comply with the following rules: ** If different parts of the package are released under different licenses, then +comma+ separate licenses (e.g. +`LIBFOO_LICENSE = GPLv2+, LGPLv2.1+`+). If there is clear distinction between which component is licensed under what license, then annotate the license with that component, between parenthesis (e.g. +`LIBFOO_LICENSE = GPLv2+ (programs), LGPLv2.1+ (libraries)`+). ** If the package is dual licensed, then separate licenses with the +or+ keyword (e.g. +`LIBFOO_LICENSE = AFLv2.1 or GPLv2+`+). * +LIBFOO_LICENSE_FILES+ is a space-separated list of files in the package tarball that contain the license(s) under which the package is released. +make legal-info+ copies all of these files in the +legal-info+ directory. See xref:legal-info[] for more information. This variable is optional. If it is not defined, a warning will be produced to let you know, and +not saved+ will appear in the +license files+ field of the manifest file for this package. * +LIBFOO_ACTUAL_SOURCE_TARBALL+ only applies to packages whose +LIBFOO_SITE+ / +LIBTOO_SOURCE+ pair points to an archive that does not actually contain source code, but binary code. This a very uncommon case, only known to apply to external toolchains which come already compiled, although theoretically it might apply to other packages. In such cases a separate tarball is usually available with the actual source code. Set +LIBFOO_ACTUAL_SOURCE_TARBALL+ to the name of the actual source code archive and Buildroot will download it and use it when you run +make legal-info+ to collect legally-relevant material. Note this file will not be downloaded during regular builds nor by +make source+. * +LIBFOO_ACTUAL_SOURCE_SITE+ provides the location of the actual source tarball. The default value is +LIBFOO_SITE+, so you don't need to set this variable if the binary and source archives are hosted on the same directory. If +LIBFOO_ACTUAL_SOURCE_TARBALL+ is not set, it doesn't make sense to define +LIBFOO_ACTUAL_SOURCE_SITE+. * +LIBFOO_REDISTRIBUTE+ can be set to +YES+ (default) or +NO+ to indicate if the package source code is allowed to be redistributed. Set it to +NO+ for non-opensource packages: Buildroot will not save the source code for this package when collecting the +legal-info+. * +LIBFOO_FLAT_STACKSIZE+ defines the stack size of an application built into the FLAT binary format. The application stack size on the NOMMU architecture processors can't be enlarged at run time. The default stack size for the FLAT binary format is only 4k bytes. If the application consumes more stack, append the required number here. The recommended way to define these variables is to use the following syntax: ---------------------- LIBFOO_VERSION = 2.32 ---------------------- Now, the variables that define what should be performed at the different steps of the build process. * +LIBFOO_EXTRACT_CMDS+ lists the actions to be performed to extract the package. This is generally not needed as tarballs are automatically handled by Buildroot. However, if the package uses a non-standard archive format, such as a ZIP or RAR file, or has a tarball with a non-standard organization, this variable allows to override the package infrastructure default behavior. * +LIBFOO_CONFIGURE_CMDS+ lists the actions to be performed to configure the package before its compilation. * +LIBFOO_BUILD_CMDS+ lists the actions to be performed to compile the package. * +HOST_LIBFOO_INSTALL_CMDS+ lists the actions to be performed to install the package, when the package is a host package. The package must install its files to the directory given by +$(HOST_DIR)+. All files, including development files such as headers should be installed, since other packages might be compiled on top of this package. * +LIBFOO_INSTALL_TARGET_CMDS+ lists the actions to be performed to install the package to the target directory, when the package is a target package. The package must install its files to the directory given by +$(TARGET_DIR)+. Only the files required for 'execution' of the package have to be installed. Header files, static libraries and documentation will be removed again when the target filesystem is finalized. * +LIBFOO_INSTALL_STAGING_CMDS+ lists the actions to be performed to install the package to the staging directory, when the package is a target package. The package must install its files to the directory given by +$(STAGING_DIR)+. All development files should be installed, since they might be needed to compile other packages. * +LIBFOO_INSTALL_IMAGES_CMDS+ lists the actions to be performed to install the package to the images directory, when the package is a target package. The package must install its files to the directory given by +$(BINARIES_DIR)+. Only files that are binary images (aka images) that do not belong in the +TARGET_DIR+ but are necessary for booting the board should be placed here. For example, a package should utilize this step if it has binaries which would be similar to the kernel image, bootloader or root filesystem images. * +LIBFOO_INSTALL_INIT_SYSV+ and +LIBFOO_INSTALL_INIT_SYSTEMD+ list the actions to install init scripts either for the systemV-like init systems (busybox, sysvinit, etc.) or for the systemd units. These commands will be run only when the relevant init system is installed (i.e. if systemd is selected as the init system in the configuration, only +LIBFOO_INSTALL_INIT_SYSTEMD+ will be run). * +LIBFOO_HELP_CMDS+ lists the actions to print the package help, which is included to the main +make help+ output. These commands can print anything in any format. This is seldom used, as packages rarely have custom rules. *Do not use this variable*, unless you really know that you need to print help. The preferred way to define these variables is: ---------------------- define LIBFOO_CONFIGURE_CMDS action 1 action 2 action 3 endef ---------------------- In the action definitions, you can use the following variables: * +$(FOO_PKGDIR)+ contains the path to the directory containing the +foo.mk+ and +Config.in+ files. This variable is useful when it is necessary to install a file bundled in Buildroot, like a runtime configuration file, a splashscreen image... * +$(@D)+, which contains the directory in which the package source code has been uncompressed. * +$(TARGET_CC)+, +$(TARGET_LD)+, etc. to get the target cross-compilation utilities * +$(TARGET_CROSS)+ to get the cross-compilation toolchain prefix * Of course the +$(HOST_DIR)+, +$(STAGING_DIR)+ and +$(TARGET_DIR)+ variables to install the packages properly. Finally, you can also use hooks. See xref:hooks[] for more information.
shibajee/buildroot
docs/manual/adding-packages-generic.txt
Text
mit
25,391
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Gettext integration and interaction with packages Many packages that support internationalization use the gettext library. Dependencies for this library are fairly complicated and therefore, deserve some explanation. The 'uClibc' C library doesn't implement gettext functionality; therefore with this C library, a separate gettext must be compiled, which is provided by the additional +libintl+ library, part of the +gettext+ package. On the other hand, the 'glibc' C library does integrate its own gettext library functions, so it is not necessary to build a separate +libintl+ library. However, certain packages need some gettext utilities on the target, such as the +gettext+ program itself, which allows to retrieve translated strings, from the command line. Additionally, some packages (such as +libglib2+) do require gettext functions unconditionally, while other packages (in general, those who support +--disable-nls+) only require gettext functions when locale support is enabled. Therefore, Buildroot defines two configuration options: * +BR2_NEEDS_GETTEXT+, which is true as soon as the toolchain doesn't provide its own gettext implementation * +BR2_NEEDS_GETTEXT_IF_LOCALE+, which is true if the toolchain doesn't provide its own gettext implementation and if locale support is enabled Packages that need gettext only when locale support is enabled should: * use +select BR2_PACKAGE_GETTEXT if BR2_NEEDS_GETTEXT_IF_LOCALE+ in the +Config.in+ file; * use +$(if $(BR2_NEEDS_GETTEXT_IF_LOCALE),gettext)+ in the package +DEPENDENCIES+ variable in the +.mk+ file. Packages that unconditionally need gettext (which should be very rare) should: * use +select BR2_PACKAGE_GETTEXT if BR2_NEEDS_GETTEXT+ in the +Config.in+ file; * use +$(if $(BR2_NEEDS_GETTEXT),gettext)+ in the package +DEPENDENCIES+ variable in the +.mk+ file. Packages that need the +gettext+ utilities on the target (should be rare) should: * use +select BR2_PACKAGE_GETTEXT+ in their +Config.in+ file, indicating in a comment above that it's a runtime dependency only. * not add any +gettext+ dependency in the +DEPENDENCIES+ variable of their +.mk+ file.
shibajee/buildroot
docs/manual/adding-packages-gettext.txt
Text
mit
2,221
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[hooks]] === Hooks available in the various build steps The generic infrastructure (and as a result also the derived autotools and cmake infrastructures) allow packages to specify hooks. These define further actions to perform after existing steps. Most hooks aren't really useful for generic packages, since the +.mk+ file already has full control over the actions performed in each step of the package construction. The following hook points are available: * +LIBFOO_PRE_DOWNLOAD_HOOKS+ * +LIBFOO_POST_DOWNLOAD_HOOKS+ * +LIBFOO_PRE_EXTRACT_HOOKS+ * +LIBFOO_POST_EXTRACT_HOOKS+ * +LIBFOO_PRE_RSYNC_HOOKS+ * +LIBFOO_POST_RSYNC_HOOKS+ * +LIBFOO_PRE_PATCH_HOOKS+ * +LIBFOO_POST_PATCH_HOOKS+ * +LIBFOO_PRE_CONFIGURE_HOOKS+ * +LIBFOO_POST_CONFIGURE_HOOKS+ * +LIBFOO_PRE_BUILD_HOOKS+ * +LIBFOO_POST_BUILD_HOOKS+ * +LIBFOO_PRE_INSTALL_HOOKS+ (for host packages only) * +LIBFOO_POST_INSTALL_HOOKS+ (for host packages only) * +LIBFOO_PRE_INSTALL_STAGING_HOOKS+ (for target packages only) * +LIBFOO_POST_INSTALL_STAGING_HOOKS+ (for target packages only) * +LIBFOO_PRE_INSTALL_TARGET_HOOKS+ (for target packages only) * +LIBFOO_POST_INSTALL_TARGET_HOOKS+ (for target packages only) * +LIBFOO_PRE_INSTALL_IMAGES_HOOKS+ * +LIBFOO_POST_INSTALL_IMAGES_HOOKS+ * +LIBFOO_PRE_LEGAL_INFO_HOOKS+ * +LIBFOO_POST_LEGAL_INFO_HOOKS+ These variables are 'lists' of variable names containing actions to be performed at this hook point. This allows several hooks to be registered at a given hook point. Here is an example: ---------------------- define LIBFOO_POST_PATCH_FIXUP action1 action2 endef LIBFOO_POST_PATCH_HOOKS += LIBFOO_POST_PATCH_FIXUP ---------------------- ==== Using the +POST_RSYNC+ hook The +POST_RSYNC+ hook is run only for packages that use a local source, either through the +local+ site method or the +OVERRIDE_SRCDIR+ mechanism. In this case, package sources are copied using +rsync+ from the local location into the buildroot build directory. The +rsync+ command does not copy all files from the source directory, though. Files belonging to a version control system, like the directories +.git+, +.hg+, etc. are not copied. For most packages this is sufficient, but a given package can perform additional actions using the +POST_RSYNC+ hook. In principle, the hook can contain any command you want. One specific use case, though, is the intentional copying of the version control directory using +rsync+. The +rsync+ command you use in the hook can, among others, use the following variables: * +$(SRCDIR)+: the path to the overridden source directory * +$(@D)+: the path to the build directory ==== Target-finalize hook Packages may also register hooks in +LIBFOO_TARGET_FINALIZE_HOOKS+. These hooks are run after all packages are built, but before the filesystem images are generated. They are seldom used, and your package probably do not need them.
shibajee/buildroot
docs/manual/adding-packages-hooks.txt
Text
mit
2,927
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for packages using kconfig for configuration files A popular way for a software package to handle user-specified configuration is +kconfig+. Among others, it is used by the Linux kernel, Busybox, and Buildroot itself. The presence of a .config file and a +menuconfig+ target are two well-known symptoms of kconfig being used. Buildroot features an infrastructure for packages that use kconfig for their configuration. This infrastructure provides the necessary logic to expose the package's +menuconfig+ target as +foo-menuconfig+ in Buildroot, and to handle the copying back and forth of the configuration file in a correct way. The +kconfig-package+ infrastructure is based on the +generic-package+ infrastructure. All variables supported by +generic-package+ are available in +kconfig-package+ as well. See xref:generic-package-reference[] for more details. In order to use the +kconfig-package+ infrastructure for a Buildroot package, the minimally required lines in the +.mk+ file, in addition to the variables required by the +generic-package+ infrastructure, are: ------------------------------ FOO_KCONFIG_FILE = reference-to-source-configuration-file $(eval $(kconfig-package)) ------------------------------ This snippet creates the following make targets: * +foo-menuconfig+, which calls the package's +menuconfig+ target * +foo-update-config+, which copies the configuration back to the source configuration file. It is not possible to use this target when fragment files are set. * +foo-update-defconfig+, which copies the configuration back to the source configuration file. The configuration file will only list the options that differ from the default values. It is not possible to use this target when fragment files are set. and ensures that the source configuration file is copied to the build directory at the right moment. There are two options to specify a configuration file to use, either +FOO_KCONFIG_FILE+ (as in the example, above) or +FOO_KCONFIG_DEFCONFIG+. It is mandatory to provide either, but not both: * +FOO_KCONFIG_FILE+ specifies the path to a defconfig or full-config file to be used to configure the package. * +FOO_KCONFIG_DEFCONFIG+ specifies the defconfig 'make' rule to call to configure the package. In addition to these minimally required lines, several optional variables can be set to suit the needs of the package under consideration: * +FOO_KCONFIG_EDITORS+: a space-separated list of kconfig editors to support, for example 'menuconfig xconfig'. By default, 'menuconfig'. * +FOO_KCONFIG_FRAGMENT_FILES+: a space-separated list of configuration fragment files that are merged to the main configuration file. Fragment files are typically used when there is a desire to stay in sync with an upstream (def)config file, with some minor modifications. * +FOO_KCONFIG_OPTS+: extra options to pass when calling the kconfig editors. This may need to include '$(FOO_MAKE_OPTS)', for example. By default, empty. * +FOO_KCONFIG_FIXUP_CMDS+: a list of shell commands needed to fixup the configuration file after copying it or running a kconfig editor. Such commands may be needed to ensure a configuration consistent with other configuration of Buildroot, for example. By default, empty.
shibajee/buildroot
docs/manual/adding-packages-kconfig.txt
Text
mit
3,346
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for packages building kernel modules Buildroot offers a helper infrastructure to make it easy to write packages that build and install Linux kernel modules. Some packages only contain a kernel module, other packages contain programs and libraries in addition to kernel modules. Buildroot's helper infrastructure supports either case. [[kernel-module-tutorial]] ==== +kernel-module+ tutorial Let's start with an example on how to prepare a simple package that only builds a kernel module, and no other component: ---- 01: ################################################################################ 02: # 03: # foo 04: # 05: ################################################################################ 06: 07: FOO_VERSION = 1.2.3 08: FOO_SOURCE = foo-$(FOO_VERSION).tar.xz 09: FOO_SITE = http://www.foosoftware.org/download 10: FOO_LICENSE = GPLv2 11: FOO_LICENSE_FILES = COPYING 12: 13: $(eval $(kernel-module)) 14: $(eval $(generic-package)) ---- Lines 7-11 define the usual meta-data to specify the version, archive name, remote URI where to find the package source, licensing information. On line 13, we invoke the +kernel-module+ helper infrastructure, that generates all the appropriate Makefile rules and variables to build that kernel module. Finally, on line 14, we invoke the xref:generic-package-tutorial[+generic-package+ infrastructure]. The dependency on +linux+ is automatically added, so it is not needed to specify it in +FOO_DEPENDENCIES+. What you may have noticed is that, unlike other package infrastructures, we explicitly invoke a second infrastructure. This allows a package to build a kernel module, but also, if needed, use any one of other package infrastructures to build normal userland components (libraries, executables...). Using the +kernel-module+ infrastructure on its own is not sufficient; another package infrastructure *must* be used. Let's look at a more complex example: ---- 01: ################################################################################ 02: # 03: # foo 04: # 05: ################################################################################ 06: 07: FOO_VERSION = 1.2.3 08: FOO_SOURCE = foo-$(FOO_VERSION).tar.xz 09: FOO_SITE = http://www.foosoftware.org/download 10: FOO_LICENSE = GPLv2 11: FOO_LICENSE_FILES = COPYING 12: 13: FOO_MODULE_SUBDIRS = driver/base 14: FOO_MODULE_MAKE_OPTS = KVERSION=$(LINUX_VERSION_PROBED) 15: 16: ifeq ($(BR2_PACKAGE_LIBBAR),y) 17: FOO_DEPENDENCIES = libbar 18: FOO_CONF_OPTS = --enable-bar 19: FOO_MODULE_SUBDIRS += driver/bar 20: else 21: FOO_CONF_OPTS = --disable-bar 22: endif 23: 24: $(eval $(kernel-module)) 26: $(eval $(autotools-package)) ---- Here, we see that we have an autotools-based package, that also builds the kernel module located in sub-directory +driver/base+ and, if libbar is enabled, the kernel module located in sub-directory +driver/bar+, and defines the variable +KVERSION+ to be passed to the Linux buildsystem when building the module(s). [[kernel-module-reference]] ==== +kernel-module+ reference The main macro for the kernel module infrastructure is +kernel-module+. Unlike other package infrastructures, it is not stand-alone, and requires any of the other +*-package+ macros be called after it. The +kernel-module+ macro defines post-build and post-target-install hooks to build the kernel modules. If the package's +.mk+ needs access to the built kernel modules, it should do so in a post-build hook, *registered after* the call to +kernel-module+. Similarly, if the package's +.mk+ needs access to the kernel module after it has been installed, it should do so in a post-install hook, *registered after* the call to +kernel-module+. Here's an example: ---- $(eval $(kernel-module)) define FOO_DO_STUFF_WITH_KERNEL_MODULE # Do something with it... endef FOO_POST_BUILD_HOOKS += FOO_DO_STUFF_WITH_KERNEL_MODULE $(eval $(generic-package)) ---- Finally, unlike the other package infrastructures, there is no +host-kernel-module+ variant to build a host kernel module. The following additional variables can optionally be defined to further configure the build of the kernel module: * +FOO_MODULE_SUBDIRS+ may be set to one or more sub-directories (relative to the package source top-directory) where the kernel module sources are. If empty or not set, the sources for the kernel module(s) are considered to be located at the top of the package source tree. * +FOO_MODULE_MAKE_OPTS+ may be set to contain extra variable definitions to pass to the Linux buildsystem. [[kernel-variables]] You may also reference (but you may *not* set!) those variables: * +LINUX_DIR+ contains the path to where the Linux kernel has been extracted and built. * +LINUX_VERSION+ contains the version string as configured by the user. * +LINUX_VERSION_PROBED+ contains the real version string of the kernel, retrieved with running `make -C $(LINUX_DIR) kernelrelease` * +KERNEL_ARCH+ contains the name of the current architecture, like `arm`, `mips`...
shibajee/buildroot
docs/manual/adding-packages-kernel-module.txt
Text
mit
5,097
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[linux-kernel-specific-infra]] === Infrastructure specific to the Linux kernel package The Linux kernel package can use some specific infrastructures based on package hooks for building Linux kernel tools or/and building Linux kernel extensions. [[linux-kernel-tools]] ==== linux-kernel-tools Buildroot offers a helper infrastructure to build some userspace tools for the target available within the Linux kernel sources. Since their source code is part of the kernel source code, it is not very practical to use separate packages for them as they often need to be built with the same kernel version as the kernel being used on the target. The small Linux kernel tools infrastructure is a simplified packaging mechanism based on the generic package infrastructure to help building those tools. Let's look at an example of a Linux tool. For a new Linux tool named +foo+, create a new menu entry in the existing +linux/Config.tools.in+. This file will contain the option descriptions related to each kernel tool that will be used and displayed in the configuration tool. It would basically look like: ------------------------------ 01: config BR2_LINUX_KERNEL_TOOL_FOO 02: bool "foo" 03: help 04: This is a comment that explains what foo kernel tool is. 05: 06: http://foosoftware.org/foo/ ------------------------------ The name of the option starts with the prefix +BR2_LINUX_KERNEL_TOOL_+, followed by the uppercase name of the tool (like is done for packages). Then for each linux tool, add a new +.mk+ file named +linux/linux-tool-foo.mk+. It would basically look like: ------------------------------ 01: ################################################################################ 02: # 03: # foo 04: # 05: ################################################################################ 06: 07: LINUX_TOOLS += foo 08: 09: FOO_DEPENDENCIES = libbbb 10: 11: define FOO_BUILD_CMDS 12: $(TARGET_MAKE_ENV) $(MAKE) -C $(@D)/tools foo 13: endef 14: 15: define FOO_INSTALL_STAGING_CMDS 16: $(TARGET_MAKE_ENV) $(MAKE) -C $(@D)/tools \ 17: DESTDIR=$(STAGING_DIR) \ 18: foo_install 19: endef 20: 21: define FOO_INSTALL_TARGET_CMDS 22: $(TARGET_MAKE_ENV) $(MAKE) -C $(@D)/tools \ 23: DESTDIR=$(@D) \ 24: foo_install 25: endef -------------------------------- On line 7, we register the Linux tool +foo+ to the list of available Linux tools. On line 9, we specify the list of dependencies this tool relies on. These dependencies are added to the Linux package dependencies list only when the +foo+ tool is selected. The rest of the Makefile, lines 11-25 defines what should be done at the different steps of the Linux tool build process like for a xref:generic-package-tutorial[+generic package+]. They will actually be used only when the +foo+ tool is selected. The only supported commands are +_BUILD_CMDS+, +_INSTALL_STAGING_CMDS+ and +_INSTALL_TARGET_CMDS+. .Note One *must not* call +$(eval $(generic-package))+ or any other package infrastructure! Linux tools are not packages by themselves, they are part of the +linux+ package. [[linux-kernel-ext]] ==== linux-kernel-extensions Some packages provide new features that require the Linux kernel tree to be modified. This can be in the form of patches to be applied on the kernel tree, or in the form of new files to be added to the tree. The Buildroot's Linux kernel extensions infrastructure provides a simple solution to automatically do this, just after the kernel sources are extracted and before the kernel patches are applied. Examples of extensions packaged using this mechanism are the real-time extensions Xenomai and RTAI, as well as the set of out-of-tree LCD screens drivers +fbtft+. Let's look at an example on how to add a new Linux extension +foo+. First, create the package +foo+ that provides the extension: this package is a standard package; see the previous chapters on how to create such a package. This package is in charge of downloading the sources archive, checking the hash, defining the licence informations and building user space tools if any. Then create the 'Linux extension' proper: create a new menu entry in the existing +linux/Config.ext.in+. This file contains the option descriptions related to each kernel extension that will be used and displayed in the configuration tool. It would basically look like: ------------------------------ 01: config BR2_LINUX_KERNEL_EXT_FOO 02: bool "foo" 03: help 04: This is a comment that explains what foo kernel extension is. 05: 06: http://foosoftware.org/foo/ ------------------------------ Then for each linux extension, add a new +.mk+ file named +linux/linux-ext-foo.mk+. It should basically contain: ------------------------------ 01: ################################################################################ 02: # 03: # foo 04: # 05: ################################################################################ 06: 07: LINUX_EXTENSIONS += foo 08: 09: define FOO_PREPARE_KERNEL 10: $(FOO_DIR)/prepare-kernel-tree.sh --linux-dir=$(@D) 11: endef -------------------------------- On line 7, we add the Linux extension +foo+ to the list of available Linux extensions. On line 9-11, we define what should be done by the extension to modify the Linux kernel tree; this is specific to the linux extension and can use the variables defined by the +foo+ package, like: +$(FOO_DIR)+ or +$(FOO_VERSION)+... as well as all the Linux variables, like: +$(LINUX_VERSION)+ or +$(LINUX_VERSION_PROBED)+, +$(KERNEL_ARCH)+... See the xref:kernel-variables[definition of those kernel variables].
shibajee/buildroot
docs/manual/adding-packages-linux-kernel-spec-infra.txt
Text
mit
5,614
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for LuaRocks-based packages [[luarocks-package-tutorial]] ==== +luarocks-package+ tutorial First, let's see how to write a +.mk+ file for a LuaRocks-based package, with an example : ------------------------ 01: ################################################################################ 02: # 03: # luafoo 04: # 05: ################################################################################ 06: 07: LUAFOO_VERSION = 1.0.2-1 08: LUAFOO_DEPENDENCIES = foo 09: 10: LUAFOO_BUILD_OPTS += FOO_INCDIR=$(STAGING_DIR)/usr/include 11: LUAFOO_BUILD_OPTS += FOO_LIBDIR=$(STAGING_DIR)/usr/lib 12: LUAFOO_LICENSE = luaFoo license 13: LUAFOO_LICENSE_FILES = COPYING 14: 15: $(eval $(luarocks-package)) ------------------------ On line 7, we declare the version of the package (the same as in the rockspec, which is the concatenation of the upstream version and the rockspec revision, separated by a hyphen '-'). On line 8, we declare our dependencies against native libraries, so that they are built before the build process of our package starts. On lines 10-11, we tell Buildroot to pass custom options to LuaRocks when it is building the package. On lines 12-13, we specify the licensing terms for the package. Finally, on line 15, we invoke the +luarocks-package+ macro that generates all the Makefile rules that actually allows the package to be built. [[luarocks-package-reference]] ==== +luarocks-package+ reference LuaRocks is a deployment and management system for Lua modules, and supports various +build.type+: +builtin+, +make+ and +cmake+. In the context of Buildroot, the +luarocks-package+ infrastructure only supports the +builtin+ mode. LuaRocks packages that use the +make+ or +cmake+ build mechanisms should instead be packaged using the +generic-package+ and +cmake-package+ infrastructures in Buildroot, respectively. The main macro of the LuaRocks package infrastructure is +luarocks-package+: like +generic-package+ it works by defining a number of variables providing metadata information about the package, and then calling +luarocks-package+. It is worth mentioning that building LuaRocks packages for the host is not supported, so the macro +host-luarocks-package+ is not implemented. Just like the generic infrastructure, the LuaRocks infrastructure works by defining a number of variables before calling the +luarocks-package+ macro. First, all the package metadata information variables that exist in the generic infrastructure also exist in the LuaRocks infrastructure: +LUAFOO_VERSION+, +LUAFOO_SOURCE+, +LUAFOO_SITE+, +LUAFOO_DEPENDENCIES+, +LUAFOO_LICENSE+, +LUAFOO_LICENSE_FILES+. Two of them are populated by the LuaRocks infrastructure (for the +download+ step). If your package is not hosted on the LuaRocks mirror +$(BR2_LUAROCKS_MIRROR)+, you can override them: * +LUAFOO_SITE+, which defaults to +$(BR2_LUAROCKS_MIRROR)+ * +LUAFOO_SOURCE+, which defaults to +luafoo-$(LUAFOO_VERSION).src.rock+ A few additional variables, specific to the LuaRocks infrastructure, are also defined. They can be overridden in specific cases. * +LUAFOO_ROCKSPEC+, which defaults to +luafoo-$(LUAFOO_VERSION).rockspec+ * +LUAFOO_SUBDIR+, which defaults to +luafoo-$(LUAFOO_VERSION_WITHOUT_ROCKSPEC_REVISION)+ * +LUAFOO_BUILD_OPTS+ contains additional build options for the +luarocks build+ call.
shibajee/buildroot
docs/manual/adding-packages-luarocks.txt
Text
mit
3,408
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for Perl/CPAN packages [[perl-package-tutorial]] ==== +perl-package+ tutorial First, let's see how to write a +.mk+ file for a Perl/CPAN package, with an example : ------------------------ 01: ################################################################################ 02: # 03: # perl-foo-bar 04: # 05: ################################################################################ 06: 07: PERL_FOO_BAR_VERSION = 0.02 08: PERL_FOO_BAR_SOURCE = Foo-Bar-$(PERL_FOO_BAR_VERSION).tar.gz 09: PERL_FOO_BAR_SITE = $(BR2_CPAN_MIRROR)/authors/id/M/MO/MONGER 10: PERL_FOO_BAR_DEPENDENCIES = perl-strictures 11: PERL_FOO_BAR_LICENSE = Artistic or GPLv1+ 12: PERL_FOO_BAR_LICENSE_FILES = LICENSE 13: 14: $(eval $(perl-package)) ------------------------ On line 7, we declare the version of the package. On line 8 and 9, we declare the name of the tarball and the location of the tarball on a CPAN server. Buildroot will automatically download the tarball from this location. On line 10, we declare our dependencies, so that they are built before the build process of our package starts. On line 11 and 12, we give licensing details about the package (its license on line 11, and the file containing the license text on line 12). Finally, on line 14, we invoke the +perl-package+ macro that generates all the Makefile rules that actually allow the package to be built. Most of these data can be retrieved from https://metacpan.org/. So, this file and the Config.in can be generated by running the script +supports/scripts/scancpan Foo-Bar+ in the Buildroot directory (or in the +BR2_EXTERNAL+ directory). This script creates a Config.in file and foo-bar.mk file for the requested package, and also recursively for all dependencies specified by CPAN. You should still manually edit the result. In particular, the following things should be checked. * If the perl module links with a shared library that is provided by another (non-perl) package, this dependency is not added automatically. It has to be added manually to +PERL_FOO_BAR_DEPENDENCIES+. * The +package/Config.in+ file has to be updated manually to include the generated Config.in files. As a hint, the +scancpan+ script prints out the required +source "..."+ statements, sorted alphabetically. [[perl-package-reference]] ==== +perl-package+ reference As a policy, packages that provide Perl/CPAN modules should all be named +perl-<something>+ in Buildroot. This infrastructure handles various Perl build systems : +ExtUtils-MakeMaker+, +Module-Build+ and +Module-Build-Tiny+. +Build.PL+ is always preferred when a package provides a +Makefile.PL+ and a +Build.PL+. The main macro of the Perl/CPAN package infrastructure is +perl-package+. It is similar to the +generic-package+ macro. The ability to have target and host packages is also available, with the +host-perl-package+ macro. Just like the generic infrastructure, the Perl/CPAN infrastructure works by defining a number of variables before calling the +perl-package+ macro. First, all the package metadata information variables that exist in the generic infrastructure also exist in the Perl/CPAN infrastructure: +PERL_FOO_VERSION+, +PERL_FOO_SOURCE+, +PERL_FOO_PATCH+, +PERL_FOO_SITE+, +PERL_FOO_SUBDIR+, +PERL_FOO_DEPENDENCIES+, +PERL_FOO_INSTALL_TARGET+. Note that setting +PERL_FOO_INSTALL_STAGING+ to +YES+ has no effect unless a +PERL_FOO_INSTALL_STAGING_CMDS+ variable is defined. The perl infrastructure doesn't define these commands since Perl modules generally don't need to be installed to the +staging+ directory. A few additional variables, specific to the Perl/CPAN infrastructure, can also be defined. Many of them are only useful in very specific cases, typical packages will therefore only use a few of them. * +PERL_FOO_CONF_ENV+/+HOST_PERL_FOO_CONF_ENV+, to specify additional environment variables to pass to the +perl Makefile.PL+ or +perl Build.PL+. By default, empty. * +PERL_FOO_CONF_OPTS+/+HOST_PERL_FOO_CONF_OPTS+, to specify additional configure options to pass to the +perl Makefile.PL+ or +perl Build.PL+. By default, empty. * +PERL_FOO_BUILD_OPTS+/+HOST_PERL_FOO_BUILD_OPTS+, to specify additional options to pass to +make pure_all+ or +perl Build build+ in the build step. By default, empty. * +PERL_FOO_INSTALL_TARGET_OPTS+, to specify additional options to pass to +make pure_install+ or +perl Build install+ in the install step. By default, empty. * +HOST_PERL_FOO_INSTALL_OPTS+, to specify additional options to pass to +make pure_install+ or +perl Build install+ in the install step. By default, empty.
shibajee/buildroot
docs/manual/adding-packages-perl.txt
Text
mit
4,678
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for Python packages This infrastructure applies to Python packages that use the standard Python setuptools mechanism as their build system, generally recognizable by the usage of a +setup.py+ script. [[python-package-tutorial]] ==== +python-package+ tutorial First, let's see how to write a +.mk+ file for a Python package, with an example : ------------------------ 01: ################################################################################ 02: # 03: # python-foo 04: # 05: ################################################################################ 06: 07: PYTHON_FOO_VERSION = 1.0 08: PYTHON_FOO_SOURCE = python-foo-$(PYTHON_FOO_VERSION).tar.xz 09: PYTHON_FOO_SITE = http://www.foosoftware.org/download 10: PYTHON_FOO_LICENSE = BSD-3c 11: PYTHON_FOO_LICENSE_FILES = LICENSE 12: PYTHON_FOO_ENV = SOME_VAR=1 13: PYTHON_FOO_DEPENDENCIES = libmad 14: PYTHON_FOO_SETUP_TYPE = distutils 15: 16: $(eval $(python-package)) ------------------------ On line 7, we declare the version of the package. On line 8 and 9, we declare the name of the tarball (xz-ed tarball recommended) and the location of the tarball on the Web. Buildroot will automatically download the tarball from this location. On line 10 and 11, we give licensing details about the package (its license on line 10, and the file containing the license text on line 11). On line 12, we tell Buildroot to pass custom options to the Python +setup.py+ script when it is configuring the package. On line 13, we declare our dependencies, so that they are built before the build process of our package starts. On line 14, we declare the specific Python build system being used. In this case the +distutils+ Python build system is used. The two supported ones are +distutils+ and +setuptools+. Finally, on line 16, we invoke the +python-package+ macro that generates all the Makefile rules that actually allow the package to be built. [[python-package-reference]] ==== +python-package+ reference As a policy, packages that merely provide Python modules should all be named +python-<something>+ in Buildroot. Other packages that use the Python build system, but are not Python modules, can freely choose their name (existing examples in Buildroot are +scons+ and +supervisor+). In their +Config.in+ file, they should depend on +BR2_PACKAGE_PYTHON+ so that when Buildroot will enable Python 3 usage for modules, we will be able to enable Python modules progressively on Python 3. The main macro of the Python package infrastructure is +python-package+. It is similar to the +generic-package+ macro. It is also possible to create Python host packages with the +host-python-package+ macro. Just like the generic infrastructure, the Python infrastructure works by defining a number of variables before calling the +python-package+ or +host-python-package+ macros. All the package metadata information variables that exist in the xref:generic-package-reference[generic package infrastructure] also exist in the Python infrastructure: +PYTHON_FOO_VERSION+, +PYTHON_FOO_SOURCE+, +PYTHON_FOO_PATCH+, +PYTHON_FOO_SITE+, +PYTHON_FOO_SUBDIR+, +PYTHON_FOO_DEPENDENCIES+, +PYTHON_FOO_LICENSE+, +PYTHON_FOO_LICENSE_FILES+, +PYTHON_FOO_INSTALL_STAGING+, etc. Note that: * It is not necessary to add +python+ or +host-python+ in the +PYTHON_FOO_DEPENDENCIES+ variable of a package, since these basic dependencies are automatically added as needed by the Python package infrastructure. * Similarly, it is not needed to add +host-setuptools+ and/or +host-distutilscross+ dependencies to +PYTHON_FOO_DEPENDENCIES+ for setuptools-based packages, since these are automatically added by the Python infrastructure as needed. One variable specific to the Python infrastructure is mandatory: * +PYTHON_FOO_SETUP_TYPE+, to define which Python build system is used by the package. The two supported values are +distutils+ and +setuptools+. If you don't know which one is used in your package, look at the +setup.py+ file in your package source code, and see whether it imports things from the +distutils+ module or the +setuptools+ module. A few additional variables, specific to the Python infrastructure, can optionally be defined, depending on the package's needs. Many of them are only useful in very specific cases, typical packages will therefore only use a few of them, or none. * +PYTHON_FOO_ENV+, to specify additional environment variables to pass to the Python +setup.py+ script (for both the build and install steps). Note that the infrastructure is automatically passing several standard variables, defined in +PKG_PYTHON_DISTUTILS_ENV+ (for distutils target packages), +HOST_PKG_PYTHON_DISTUTILS_ENV+ (for distutils host packages), +PKG_PYTHON_SETUPTOOLS_ENV+ (for setuptools target packages) and +HOST_PKG_PYTHON_SETUPTOOLS_ENV+ (for setuptools host packages). * +PYTHON_FOO_BUILD_OPTS+, to specify additional options to pass to the Python +setup.py+ script during the build step. For target distutils packages, the +PKG_PYTHON_DISTUTILS_BUILD_OPTS+ options are already passed automatically by the infrastructure. * +PYTHON_FOO_INSTALL_TARGET_OPTS+, +PYTHON_FOO_INSTALL_STAGING_OPTS+, +HOST_PYTHON_FOO_INSTALL_OPTS+ to specify additional options to pass to the Python +setup.py+ script during the target installation step, the staging installation step or the host installation, respectively. Note that the infrastructure is automatically passing some options, defined in +PKG_PYTHON_DISTUTILS_INSTALL_TARGET_OPTS+ or +PKG_PYTHON_DISTUTILS_INSTALL_STAGING_OPTS+ (for target distutils packages), +HOST_PKG_PYTHON_DISTUTILS_INSTALL_OPTS+ (for host distutils packages), +PKG_PYTHON_SETUPTOOLS_INSTALL_TARGET_OPTS+ or +PKG_PYTHON_SETUPTOOLS_INSTALL_STAGING_OPTS+ (for target setuptools packages) and +HOST_PKG_PYTHON_SETUPTOOLS_INSTALL_OPTS+ (for host setuptools packages). * +HOST_PYTHON_FOO_NEEDS_HOST_PYTHON+, to define the host python interpreter. The usage of this variable is limited to host packages. The two supported value are +python2+ and +python3+. It will ensure the right host python package is available and will invoke it for the build. If some build steps are overloaded, the right python interpreter must be explicitly called in the commands. With the Python infrastructure, all the steps required to build and install the packages are already defined, and they generally work well for most Python-based packages. However, when required, it is still possible to customize what is done in any particular step: * By adding a post-operation hook (after extract, patch, configure, build or install). See xref:hooks[] for details. * By overriding one of the steps. For example, even if the Python infrastructure is used, if the package +.mk+ file defines its own +PYTHON_FOO_BUILD_CMDS+ variable, it will be used instead of the default Python one. However, using this method should be restricted to very specific cases. Do not use it in the general case. [[scanpypi]] ==== Generating a +python-package+ from a PyPI repository If the Python package for which you would like to create a Buildroot package is available on PyPI, you may want to use the +scanpypi+ tool located in +support/scripts+ to automate the process. You can find the list of existing PyPI packages https://pypi.python.org[here]. +scanpypi+ requires Python's +setuptools+ package to be installed on your host. When at the root of your buildroot directory just do : ----------------------- ./support/script/scanpypi foo bar -o package ----------------------- This will generate packages +python-foo+ and +python-bar+ in the package folder if they exist on https://pypi.python.org. Find the +external python modules+ menu and insert your package inside. Keep in mind that the items inside a menu should be in alphabetical order. Please keep in mind that you'll most likely have to manually check the package for any mistakes as there are things that cannot be guessed by the generator (e.g. dependencies on any of the python core modules such as BR2_PACKAGE_PYTHON_ZLIB). Also, please take note that the license and license files are guessed and must be checked. You also need to manually add the package to the +package/Config.in+ file. If your Buildroot package is not in the official Buildroot tree but in a +BR2_EXTERNAL+ tree, use the -o flag as follows: ----------------------- ./support/script/scanpypi foo bar -o other_package_dir ----------------------- This will generate packages +python-foo+ and +python-bar+ in the +other_package_directory+ instead of +package+. Option +-h+ will list the available options: ----------------------- ./support/script/scanpypi -h ----------------------- [[python-package-cffi-backend]] ==== +python-package+ CFFI backend C Foreign Function Interface for Python (CFFI) provides a convenient and reliable way to call compiled C code from Python using interface declarations written in C. Python packages relying on this backend can be identified by the appearance of a +cffi+ dependency in the +install_requires+ field of their +setup.py+ file. Such a package should: * add +python-cffi+ as a runtime dependency in order to install the compiled C library wrapper on the target. This is achieved by adding +select BR2_PACKAGE_PYTHON_CFFI+ to the package +Config.in+. ------------------------ config BR2_PACKAGE_PYTHON_FOO bool "python-foo" select BR2_PACKAGE_PYTHON_CFFI # runtime ------------------------ * add +host-python-cffi+ as a build-time dependency in order to cross-compile the C wrapper. This is achieved by adding +host-python-cffi+ to the +PYTHON_FOO_DEPENDENCIES+ variable. ------------------------ ################################################################################ # # python-foo # ################################################################################ ... PYTHON_FOO_DEPENDENCIES = host-python-cffi $(eval $(python-package)) ------------------------
shibajee/buildroot
docs/manual/adding-packages-python.txt
Text
mit
10,099
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for rebar-based packages [[rebar-package-tutorial]] ==== +rebar-package+ tutorial First, let's see how to write a +.mk+ file for a rebar-based package, with an example : ------------------------------ 01: ################################################################################ 02: # 03: # erlang-foobar 04: # 05: ################################################################################ 06: 07: ERLANG_FOOBAR_VERSION = 1.0 08: ERLANG_FOOBAR_SOURCE = erlang-foobar-$(ERLANG_FOOBAR_VERSION).tar.xz 09: ERLANG_FOOBAR_SITE = http://www.foosoftware.org/download 10: ERLANG_FOOBAR_DEPENDENCIES = host-libaaa libbbb 11: 12: $(eval $(rebar-package)) -------------------------------- On line 7, we declare the version of the package. On line 8 and 9, we declare the name of the tarball (xz-ed tarball recommended) and the location of the tarball on the Web. Buildroot will automatically download the tarball from this location. On line 10, we declare our dependencies, so that they are built before the build process of our package starts. Finally, on line 12, we invoke the +rebar-package+ macro that generates all the Makefile rules that actually allows the package to be built. [[rebar-package-reference]] ==== +rebar-package+ reference The main macro of the +rebar+ package infrastructure is +rebar-package+. It is similar to the +generic-package+ macro. The ability to have host packages is also available, with the +host-rebar-package+ macro. Just like the generic infrastructure, the +rebar+ infrastructure works by defining a number of variables before calling the +rebar-package+ macro. First, all the package metadata information variables that exist in the generic infrastructure also exist in the +rebar+ infrastructure: +ERLANG_FOOBAR_VERSION+, +ERLANG_FOOBAR_SOURCE+, +ERLANG_FOOBAR_PATCH+, +ERLANG_FOOBAR_SITE+, +ERLANG_FOOBAR_SUBDIR+, +ERLANG_FOOBAR_DEPENDENCIES+, +ERLANG_FOOBAR_INSTALL_STAGING+, +ERLANG_FOOBAR_INSTALL_TARGET+, +ERLANG_FOOBAR_LICENSE+ and +ERLANG_FOOBAR_LICENSE_FILES+. A few additional variables, specific to the +rebar+ infrastructure, can also be defined. Many of them are only useful in very specific cases, typical packages will therefore only use a few of them. * +ERLANG_FOOBAR_USE_AUTOCONF+, to specify that the package uses _autoconf_ at the configuration step. When a package sets this variable to +YES+, the +autotools+ infrastructure is used. + .Note You can also use some of the variables from the +autotools+ infrastructure: +ERLANG_FOOBAR_CONF_ENV+, +ERLANG_FOOBAR_CONF_OPTS+, +ERLANG_FOOBAR_AUTORECONF+, +ERLANG_FOOBAR_AUTORECONF_ENV+ and +ERLANG_FOOBAR_AUTORECONF_OPTS+. * +ERLANG_FOOBAR_USE_BUNDLED_REBAR+, to specify that the package has a bundled version of _rebar_ *and* that it shall be used. Valid values are +YES+ or +NO+ (the default). + .Note If the package bundles a _rebar_ utility, but can use the generic one that Buildroot provides, just say +NO+ (i.e., do not specify this variable). Only set if it is mandatory to use the _rebar_ utility bundled in this package. * +ERLANG_FOOBAR_REBAR_ENV+, to specify additional environment variables to pass to the _rebar_ utility. With the rebar infrastructure, all the steps required to build and install the packages are already defined, and they generally work well for most rebar-based packages. However, when required, it is still possible to customize what is done in any particular step: * By adding a post-operation hook (after extract, patch, configure, build or install). See xref:hooks[] for details. * By overriding one of the steps. For example, even if the rebar infrastructure is used, if the package +.mk+ file defines its own +ERLANG_FOOBAR_BUILD_CMDS+ variable, it will be used instead of the default rebar one. However, using this method should be restricted to very specific cases. Do not use it in the general case.
shibajee/buildroot
docs/manual/adding-packages-rebar.txt
Text
mit
3,974
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Tips and tricks [[package-name-variable-relation]] ==== Package name, config entry name and makefile variable relationship In Buildroot, there is some relationship between: * the _package name_, which is the package directory name (and the name of the +*.mk+ file); * the config entry name that is declared in the +Config.in+ file; * the makefile variable prefix. It is mandatory to maintain consistency between these elements, using the following rules: * the package directory and the +*.mk+ name are the _package name_ itself (e.g.: +package/foo-bar_boo/foo-bar_boo.mk+); * the _make_ target name is the _package name_ itself (e.g.: +foo-bar_boo+); * the config entry is the upper case _package name_ with `.` and `-` characters substituted with `_`, prefixed with +BR2_PACKAGE_+ (e.g.: +BR2_PACKAGE_FOO_BAR_BOO+); * the +*.mk+ file variable prefix is the upper case _package name_ with `.` and `-` characters substituted with `_` (e.g.: +FOO_BAR_BOO_VERSION+). [[github-download-url]] ==== How to add a package from GitHub Packages on GitHub often don't have a download area with release tarballs. However, it is possible to download tarballs directly from the repository on GitHub. As GitHub is known to have changed download mechanisms in the past, the 'github' helper function should be used as shown below. ------------------------ # Use a tag or a full commit ID FOO_VERSION = v1.0 FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION)) ------------------------ .Notes - The FOO_VERSION can either be a tag or a commit ID. - The tarball name generated by github matches the default one from Buildroot (e.g.: +foo-f6fb6654af62045239caed5950bc6c7971965e60.tar.gz+), so it is not necessary to specify it in the +.mk+ file. - When using a commit ID as version, you should use the full 40 hex characters. If the package you wish to add does have a release section on GitHub, the maintainer may have uploaded a release tarball, or the release may just point to the automatically generated tarball from the git tag. If there is a release tarball uploaded by the maintainer, we prefer to use that since it may be slightly different (e.g. it contains a configure script so we don't need to do AUTORECONF). You can see on the release page if it's an uploaded tarball or a git tag: image::github_hash_mongrel2.png[] - If it looks like the image above then it was uploaded by the maintainer and you should use that link (in that example: 'mongrel2-v1.9.2.tar.bz2') to specify +FOO_SITE+, and not use the 'github' helper. - On the other hand, if there's is *only* the "Source code" link, then it's an automatically generated tarball and you should use the 'github' helper function.
shibajee/buildroot
docs/manual/adding-packages-tips.txt
Text
mit
2,784
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Infrastructure for virtual packages [[virtual-package-tutorial]] In Buildroot, a virtual package is a package whose functionalities are provided by one or more packages, referred to as 'providers'. The virtual package management is an extensible mechanism allowing the user to choose the provider used in the rootfs. For example, 'OpenGL ES' is an API for 2D and 3D graphics on embedded systems. The implementation of this API is different for the 'Allwinner Tech Sunxi' and the 'Texas Instruments OMAP35xx' platforms. So +libgles+ will be a virtual package and +sunxi-mali+ and +ti-gfx+ will be the providers. ==== +virtual-package+ tutorial In the following example, we will explain how to add a new virtual package ('something-virtual') and a provider for it ('some-provider'). First, let's create the virtual package. ==== Virtual package's +Config.in+ file The +Config.in+ file of virtual package 'something-virtual' should contain: --------------------------- 01: config BR2_PACKAGE_HAS_SOMETHING_VIRTUAL 02: bool 03: 04: config BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL 05: depends on BR2_PACKAGE_HAS_SOMETHING_VIRTUAL 06: string --------------------------- In this file, we declare two options, +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+ and +BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+, whose values will be used by the providers. ==== Virtual package's +.mk+ file The +.mk+ for the virtual package should just evaluate the +virtual-package+ macro: --------------------------- 01: ################################################################################ 02: # 03: # something-virtual 04: # 05: ################################################################################ 06: 07: $(eval $(virtual-package)) --------------------------- The ability to have target and host packages is also available, with the +host-virtual-package+ macro. ==== Provider's +Config.in+ file When adding a package as a provider, only the +Config.in+ file requires some modifications. The +Config.in+ file of the package 'some-provider', which provides the functionalities of 'something-virtual', should contain: --------------------------- 01: config BR2_PACKAGE_SOME_PROVIDER 02: bool "some-provider" 03: select BR2_PACKAGE_HAS_SOMETHING_VIRTUAL 04: help 05: This is a comment that explains what some-provider is. 06: 07: http://foosoftware.org/some-provider/ 08: 09: if BR2_PACKAGE_SOME_PROVIDER 10: config BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL 11: default "some-provider" 12: endif --------------------------- On line 3, we select +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+, and on line 11, we set the value of +BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+ to the name of the provider, but only if it is selected. See xref:virtual-package-list[] for the symbols to select if you implement a new provider for an existing virtual package. ==== Provider's +.mk+ file The +.mk+ file should also declare an additional variable +SOME_PROVIDER_PROVIDES+ to contain the names of all the virtual packages it is an implementation of: --------------------------- 01: SOME_PROVIDER_PROVIDES = something-virtual --------------------------- Of course, do not forget to add the proper build and runtime dependencies for this package! See xref:virtual-package-list[] for the names of virtual packages to provide if you implement a new provider for an existing virtual package. ==== Notes on depending on a virtual package When adding a package that requires a certain +FEATURE+ provided by a virtual package, you have to use +depends on BR2_PACKAGE_HAS_FEATURE+, like so: --------------------------- config BR2_PACKAGE_HAS_FEATURE bool config BR2_PACKAGE_FOO bool "foo" depends on BR2_PACKAGE_HAS_FEATURE --------------------------- ==== Notes on depending on a specific provider If your package really requires a specific provider, then you'll have to make your package +depends on+ this provider; you can _not_ +select+ a provider. Let's take an example with two providers for a +FEATURE+: --------------------------- config BR2_PACKAGE_HAS_FEATURE bool config BR2_PACKAGE_FOO bool "foo" select BR2_PACKAGE_HAS_FEATURE config BR2_PACKAGE_BAR bool "bar" select BR2_PACKAGE_HAS_FEATURE --------------------------- And you are adding a package that needs +FEATURE+ as provided by +foo+, but not as provided by +bar+. If you were to use +select BR2_PACKAGE_FOO+, then the user would still be able to select +BR2_PACKAGE_BAR+ in the menuconfig. This would create a configuration inconsistency, whereby two providers of the same +FEATURE+ would be enabled at once, one explicitly set by the user, the other implicitly by your +select+. Instead, you have to use +depends on BR2_PACKAGE_FOO+, which avoids any implicit configuration inconsistency.
shibajee/buildroot
docs/manual/adding-packages-virtual.txt
Text
mit
4,832
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[adding-packages]] == Adding new packages to Buildroot This section covers how new packages (userspace libraries or applications) can be integrated into Buildroot. It also shows how existing packages are integrated, which is needed for fixing issues or tuning their configuration. include::adding-packages-directory.txt[] include::adding-packages-generic.txt[] include::adding-packages-autotools.txt[] include::adding-packages-cmake.txt[] include::adding-packages-python.txt[] include::adding-packages-luarocks.txt[] include::adding-packages-perl.txt[] include::adding-packages-virtual.txt[] include::adding-packages-kconfig.txt[] include::adding-packages-rebar.txt[] include::adding-packages-kernel-module.txt[] include::adding-packages-asciidoc.txt[] include::adding-packages-linux-kernel-spec-infra.txt[] include::adding-packages-hooks.txt[] include::adding-packages-gettext.txt[] include::adding-packages-tips.txt[] include::adding-packages-conclusion.txt[]
shibajee/buildroot
docs/manual/adding-packages.txt
Text
mit
1,032
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Advanced usage include::using-buildroot-toolchain.txt[] include::using-buildroot-debugger.txt[] include::ccache-support.txt[] include::download-location.txt[] include::package-make-target.txt[] include::using-buildroot-development.txt[]
shibajee/buildroot
docs/manual/advanced.txt
Text
mit
298
// -*- mode:doc; -*- // vim: set syntax=asciidoc: include::makedev-syntax.txt[] include::makeusers-syntax.txt[] // Automatically generated lists: [[package-list]] == List of target packages available in Buildroot include::package-list.txt[] [[virtual-package-list]] == List of virtual packages These are the virtual packages known to +Buildroot+, with the corresponding symbols and providers. include::virtual-package-list.txt[] [[host-package-list]] == List of host utilities available in Buildroot The following packages are all available in the menu +Host utilities+. include::host-package-list.txt[] [[deprecated-list]] == Deprecated features The following features are marked as _deprecated_ in Buildroot due to them being either too old or unmaintained. They will be removed at some point, so stop using them. Each deprecated symbol in kconfig depends on a symbol +BR2_DEPRECATED_SINCE_xxxx_xx+, which provides an indication of when the feature can be removed: features will not be removed within the year following deprecation. For example, a symbol depending on +BR2_DEPRECATED_SINCE_2013_05+ can be removed from 2014.05 onwards. include::deprecated-list.txt[]
shibajee/buildroot
docs/manual/appendix.txt
Text
mit
1,183
// -*- mode:doc; -*- // vim: set syntax=asciidoc: == Beyond Buildroot === Boot the generated images ==== NFS boot To achieve NFS-boot, enable _tar root filesystem_ in the _Filesystem images_ menu. After a complete build, just run the following commands to setup the NFS-root directory: ------------------- sudo tar -xavf /path/to/output_dir/rootfs.tar -C /path/to/nfs_root_dir ------------------- Remember to add this path to +/etc/exports+. Then, you can execute a NFS-boot from your target. ==== Live CD To build a live CD image, enable the _iso image_ option in the _Filesystem images_ menu. Note that this option is only available on the x86 and x86-64 architectures, and if you are building your kernel with Buildroot. You can build a live CD image with either IsoLinux, Grub or Grub 2 as a bootloader, but only Isolinux supports making this image usable both as a live CD and live USB (through the _Build hybrid image_ option). You can test your live CD image using QEMU: ------------------- qemu-system-i386 -cdrom output/images/rootfs.iso9660 ------------------- Or use it as a hard-drive image if it is a hybrid ISO: ------------------- qemu-system-i386 -hda output/images/rootfs.iso9660 ------------------- It can be easily flashed to a USB drive with +dd+: ------------------- dd if=output/images/rootfs.iso9660 of=/dev/sdb ------------------- === Chroot If you want to chroot in a generated image, then there are few thing you should be aware of: * you should setup the new root from the _tar root filesystem_ image; * either the selected target architecture is compatible with your host machine, or you should use some +qemu-*+ binary and correctly set it within the +binfmt+ properties to be able to run the binaries built for the target on your host machine; * Buildroot does not currently provide +host-qemu+ and +binfmt+ correctly built and set for that kind of use.
shibajee/buildroot
docs/manual/beyond-buildroot.txt
Text
mit
1,914
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[ccache]] ==== Using +ccache+ in Buildroot http://ccache.samba.org[ccache] is a compiler cache. It stores the object files resulting from each compilation process, and is able to skip future compilation of the same source file (with same compiler and same arguments) by using the pre-existing object files. When doing almost identical builds from scratch a number of times, it can nicely speed up the build process. +ccache+ support is integrated in Buildroot. You just have to enable +Enable compiler cache+ in +Build options+. This will automatically build +ccache+ and use it for every host and target compilation. The cache is located in +$HOME/.buildroot-ccache+. It is stored outside of Buildroot output directory so that it can be shared by separate Buildroot builds. If you want to get rid of the cache, simply remove this directory. You can get statistics on the cache (its size, number of hits, misses, etc.) by running +make ccache-stats+. The make target +ccache-options+ and the +CCACHE_OPTIONS+ variable provide more generic access to the ccache. For example ----------------- # set cache limit size make CCACHE_OPTIONS="--max-size=5G" ccache-options # zero statistics counters make CCACHE_OPTIONS="--zero-stats" ccache-options ----------------- +ccache+ makes a hash of the source files and of the compiler options. If a compiler option is different, the cached object file will not be used. Many compiler options, however, contain an absolute path to the staging directory. Because of this, building in a different output directory would lead to many cache misses. To avoid this issue, buildroot has the +Use relative paths+ option (+BR2_CCACHE_USE_BASEDIR+). This will rewrite all absolute paths that point inside the output directory into relative paths. Thus, changing the output directory no longer leads to cache misses. A disadvantage of the relative paths is that they also end up to be relative paths in the object file. Therefore, for example, the debugger will no longer find the file, unless you cd to the output directory first. See https://ccache.samba.org/manual.html#_compiling_in_different_directories[the ccache manual's section on "Compiling in different directories"] for more details about this rewriting of absolute paths.
shibajee/buildroot
docs/manual/ccache-support.txt
Text
mit
2,323
// -*- mode:doc; -*- // vim: set syntax=asciidoc: == General Buildroot usage include::make-tips.txt[] include::rebuilding-packages.txt[] === Offline builds If you intend to do an offline build and just want to download all sources that you previously selected in the configurator ('menuconfig', 'nconfig', 'xconfig' or 'gconfig'), then issue: -------------------- $ make source -------------------- You can now disconnect or copy the content of your +dl+ directory to the build-host. === Building out-of-tree As default, everything built by Buildroot is stored in the directory +output+ in the Buildroot tree. Buildroot also supports building out of tree with a syntax similar to the Linux kernel. To use it, add +O=<directory>+ to the make command line: -------------------- $ make O=/tmp/build -------------------- Or: -------------------- $ cd /tmp/build; make O=$PWD -C path/to/buildroot -------------------- All the output files will be located under +/tmp/build+. If the +O+ path does not exist, Buildroot will create it. *Note:* the +O+ path can be either an absolute or a relative path, but if it's passed as a relative path, it is important to note that it is interpreted relative to the main Buildroot source directory, *not* the current working directory. When using out-of-tree builds, the Buildroot +.config+ and temporary files are also stored in the output directory. This means that you can safely run multiple builds in parallel using the same source tree as long as they use unique output directories. For ease of use, Buildroot generates a Makefile wrapper in the output directory - so after the first run, you no longer need to pass +O=<...>+ and +-C <...>+, simply run (in the output directory): -------------------- $ make <target> -------------------- [[env-vars]] === Environment variables Buildroot also honors some environment variables, when they are passed to +make+ or set in the environment: * +HOSTCXX+, the host C++ compiler to use * +HOSTCC+, the host C compiler to use * +UCLIBC_CONFIG_FILE=<path/to/.config>+, path to the uClibc configuration file, used to compile uClibc, if an internal toolchain is being built. + Note that the uClibc configuration file can also be set from the configuration interface, so through the Buildroot +.config+ file; this is the recommended way of setting it. + * +BUSYBOX_CONFIG_FILE=<path/to/.config>+, path to the BusyBox configuration file. + Note that the BusyBox configuration file can also be set from the configuration interface, so through the Buildroot +.config+ file; this is the recommended way of setting it. + * +BR2_CCACHE_DIR+ to override the directory where Buildroot stores the cached files when using ccache. + * +BR2_DL_DIR+ to override the directory in which Buildroot stores/retrieves downloaded files + Note that the Buildroot download directory can also be set from the configuration interface, so through the Buildroot +.config+ file; this is the recommended way of setting it. * +BR2_GRAPH_ALT+, if set and non-empty, to use an alternate color-scheme in build-time graphs * +BR2_GRAPH_OUT+ to set the filetype of generated graphs, either +pdf+ (the default), or +png+. * +BR2_GRAPH_DEPS_OPTS+ to pass extra options to the dependency graph; see xref:graph-depends[] for the accepted options * +BR2_GRAPH_DOT_OPTS+ is passed verbatim as options to the +dot+ utility to draw the dependency graph. An example that uses config files located in the toplevel directory and in your $HOME: -------------------- $ make UCLIBC_CONFIG_FILE=uClibc.config BUSYBOX_CONFIG_FILE=$HOME/bb.config -------------------- If you want to use a compiler other than the default +gcc+ or +g+++ for building helper-binaries on your host, then do -------------------- $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD -------------------- === Dealing efficiently with filesystem images Filesystem images can get pretty big, depending on the filesystem you choose, the number of packages, whether you provisioned free space... Yet, some locations in the filesystems images may just be _empty_ (e.g. a long run of 'zeroes'); such a file is called a _sparse_ file. Most tools can handle sparse files efficiently, and will only store or write those parts of a sparse file that are not empty. For example: * +tar+ accepts the +-S+ option to tell it to only store non-zero blocks of sparse files: ** +tar cf archive.tar -S [files...]+ will efficiently store sparse files in a tarball ** +tar xf archive.tar -S+ will efficiently store sparse files extracted from a tarball * +cp+ accepts the +--sparse=WHEN+ option (+WHEN+ is one of +auto+, +never+ or +always+): ** +cp --sparse=always source.file dest.file+ will make +dest.file+ a sparse file if +source.file+ has long runs of zeroes Other tools may have similar options. Please consult their respective man pages. You can use sparse files if you need to store the filesystem images (e.g. to transfer from one machine to another), or if you need to send them (e.g. to the Q&A team). Note however that flashing a filesystem image to a device while using the sparse mode of +dd+ may result in a broken filesystem (e.g. the block bitmap of an ext2 filesystem may be corrupted; or, if you have sparse files in your filesystem, those parts may not be all-zeroes when read back). You should only use sparse files when handling files on the build machine, not when transferring them to an actual device that will be used on the target. === Graphing the dependencies between packages [[graph-depends]] One of Buildroot's jobs is to know the dependencies between packages, and make sure they are built in the right order. These dependencies can sometimes be quite complicated, and for a given system, it is often not easy to understand why such or such package was brought into the build by Buildroot. In order to help understanding the dependencies, and therefore better understand what is the role of the different components in your embedded Linux system, Buildroot is capable of generating dependency graphs. To generate a dependency graph of the full system you have compiled, simply run: ------------------------ make graph-depends ------------------------ You will find the generated graph in +output/graphs/graph-depends.pdf+. If your system is quite large, the dependency graph may be too complex and difficult to read. It is therefore possible to generate the dependency graph just for a given package: ------------------------ make <pkg>-graph-depends ------------------------ You will find the generated graph in +output/graph/<pkg>-graph-depends.pdf+. Note that the dependency graphs are generated using the +dot+ tool from the _Graphviz_ project, which you must have installed on your system to use this feature. In most distributions, it is available as the +graphviz+ package. By default, the dependency graphs are generated in the PDF format. However, by passing the +BR2_GRAPH_OUT+ environment variable, you can switch to other output formats, such as PNG, PostScript or SVG. All formats supported by the +-T+ option of the +dot+ tool are supported. -------------------------------- BR2_GRAPH_OUT=svg make graph-depends -------------------------------- The +graph-depends+ behaviour can be controlled by setting options in the +BR2_GRAPH_DEPS_OPTS+ environment variable. The accepted options are: * +--depth N+, +-d N+, to limit the dependency depth to +N+ levels. The default, +0+, means no limit. * +--stop-on PKG+, +-s PKG+, to stop the graph on the package +PKG+. +PKG+ can be an actual package name, a glob, the keyword 'virtual' (to stop on virtual packages), or the keyword 'host' (to stop on host packages). The package is still present on the graph, but its dependencies are not. * +--exclude PKG+, +-x PKG+, like +--stop-on+, but also omits +PKG+ from the graph. * +--transitive+, +--no-transitive+, to draw (or not) the transitive dependencies. The default is to not draw transitive dependencies. * +--colours R,T,H+, the comma-separated list of colours to draw the root package (+R+), the target packages (+T+) and the host packages (+H+). Defaults to: +lightblue,grey,gainsboro+ -------------------------------- BR2_GRAPH_DEPS_OPTS='-d 3 --no-transitive --colours=red,green,blue' make graph-depends -------------------------------- === Graphing the build duration [[graph-duration]] When the build of a system takes a long time, it is sometimes useful to be able to understand which packages are the longest to build, to see if anything can be done to speed up the build. In order to help such build time analysis, Buildroot collects the build time of each step of each package, and allows to generate graphs from this data. To generate the build time graph after a build, run: ---------------- make graph-build ---------------- This will generate a set of files in +output/graphs+ : * +build.hist-build.pdf+, a histogram of the build time for each package, ordered in the build order. * +build.hist-duration.pdf+, a histogram of the build time for each package, ordered by duration (longest first) * +build.hist-name.pdf+, a histogram of the build time for each package, order by package name. * +build.pie-packages.pdf+, a pie chart of the build time per package * +build.pie-steps.pdf+, a pie chart of the global time spent in each step of the packages build process. This +graph-build+ target requires the Python Matplotlib and Numpy libraries to be installed (+python-matplotlib+ and +python-numpy+ on most distributions), and also the +argparse+ module if you're using a Python version older than 2.7 (+python-argparse+ on most distributions). By default, the output format for the graph is PDF, but a different format can be selected using the +BR2_GRAPH_OUT+ environment variable. The only other format supported is PNG: ---------------- BR2_GRAPH_OUT=png make graph-build ---------------- === Graphing the filesystem size contribution of packages When your target system grows, it is sometimes useful to understand how much each Buildroot package is contributing to the overall root filesystem size. To help with such an analysis, Buildroot collects data about files installed by each package and using this data, generates a graph and CSV files detailing the size contribution of the different packages. To generate these data after a build, run: ---------------- make graph-size ---------------- This will generate: * +output/graphs/graph-size.pdf+, a pie chart of the contribution of each package to the overall root filesystem size * +output/graphs/package-size-stats.csv+, a CSV file giving the size contribution of each package to the overall root filesystem size * +output/graphs/file-size-stats.csv+, a CSV file giving the size contribution of each installed file to the package it belongs, and to the overall filesystem size. This +graph-size+ target requires the Python Matplotlib library to be installed (+python-matplotlib+ on most distributions), and also the +argparse+ module if you're using a Python version older than 2.7 (+python-argparse+ on most distributions). Just like for the duration graph, a +BR2_GRAPH_OUT+ environment is supported to adjust the output file format. See xref:graph-depends[] for details about this environment variable. .Note The collected filesystem size data is only meaningful after a complete clean rebuild. Be sure to run +make clean all+ before using +make graph-size+. To compare the root filesystem size of two different Buildroot compilations, for example after adjusting the configuration or when switching to another Buildroot release, use the +size-stats-compare+ script. It takes two +file-size-stats.csv+ files (produced by +make graph-size+) as input. Refer to the help text of this script for more details: ---------------- support/scripts/size-stats-compare -h ---------------- include::eclipse-integration.txt[] include::advanced.txt[]
shibajee/buildroot
docs/manual/common-usage.txt
Text
mit
12,018
// -*- mode:doc; -*- // vim: set syntax=asciidoc: == Configuration of other components Before attempting to modify any of the components below, make sure you have already configured Buildroot itself, and have enabled the corresponding package. BusyBox:: + If you already have a BusyBox configuration file, you can directly specify this file in the Buildroot configuration, using +BR2_PACKAGE_BUSYBOX_CONFIG+. Otherwise, Buildroot will start from a default BusyBox configuration file. + To make subsequent changes to the configuration, use +make busybox-menuconfig+ to open the BusyBox configuration editor. + It is also possible to specify a BusyBox configuration file through an environment variable, although this is not recommended. Refer to xref:env-vars[] for more details. uClibc:: + Configuration of uClibc is done in the same way as for BusyBox. The configuration variable to specify an existing configuration file is +BR2_UCLIBC_CONFIG+. The command to make subsequent changes is +make uclibc-menuconfig+. Linux kernel:: + If you already have a kernel configuration file, you can directly specify this file in the Buildroot configuration, using +BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG+. + If you do not yet have a kernel configuration file, you can either start by specifying a defconfig in the Buildroot configuration, using +BR2_LINUX_KERNEL_USE_DEFCONFIG+, or start by creating an empty file and specifying it as custom configuration file, using +BR2_LINUX_KERNEL_USE_CUSTOM_CONFIG+. + To make subsequent changes to the configuration, use +make linux-menuconfig+ to open the Linux configuration editor. Barebox:: + Configuration of Barebox is done in the same way as for the Linux kernel. The corresponding configuration variables are +BR2_TARGET_BAREBOX_USE_CUSTOM_CONFIG+ and +BR2_TARGET_BAREBOX_USE_DEFCONFIG+. To open the configuration editor, use +make barebox-menuconfig+. U-Boot:: + Configuration of U-Boot (version 2015.04 or newer) is done in the same way as for the Linux kernel. The corresponding configuration variables are +BR2_TARGET_UBOOT_USE_CUSTOM_CONFIG+ and +BR2_TARGET_UBOOT_USE_DEFCONFIG+. To open the configuration editor, use +make uboot-menuconfig+.
shibajee/buildroot
docs/manual/configure-other-components.txt
Text
mit
2,189
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[configure]] == Buildroot configuration All the configuration options in +make *config+ have a help text providing details about the option. The +make *config+ commands also offer a search tool. Read the help message in the different frontend menus to know how to use it: * in _menuconfig_, the search tool is called by pressing +/+; * in _xconfig_, the search tool is called by pressing +Ctrl+ + +f+. The result of the search shows the help message of the matching items. In _menuconfig_, numbers in the left column provide a shortcut to the corresponding entry. Just type this number to directly jump to the entry, or to the containing menu in case the entry is not selectable due to a missing dependency. Although the menu structure and the help text of the entries should be sufficiently self-explanatory, a number of topics require additional explanation that cannot easily be covered in the help text and are therefore covered in the following sections. === Cross-compilation toolchain A compilation toolchain is the set of tools that allows you to compile code for your system. It consists of a compiler (in our case, +gcc+), binary utils like assembler and linker (in our case, +binutils+) and a C standard library (for example http://www.gnu.org/software/libc/libc.html[GNU Libc], http://www.uclibc.org/[uClibc]). The system installed on your development station certainly already has a compilation toolchain that you can use to compile an application that runs on your system. If you're using a PC, your compilation toolchain runs on an x86 processor and generates code for an x86 processor. Under most Linux systems, the compilation toolchain uses the GNU libc (glibc) as the C standard library. This compilation toolchain is called the "host compilation toolchain". The machine on which it is running, and on which you're working, is called the "host system" footnote:[This terminology differs from what is used by GNU configure, where the host is the machine on which the application will run (which is usually the same as target)]. The compilation toolchain is provided by your distribution, and Buildroot has nothing to do with it (other than using it to build a cross-compilation toolchain and other tools that are run on the development host). As said above, the compilation toolchain that comes with your system runs on and generates code for the processor in your host system. As your embedded system has a different processor, you need a cross-compilation toolchain - a compilation toolchain that runs on your _host system_ but generates code for your _target system_ (and target processor). For example, if your host system uses x86 and your target system uses ARM, the regular compilation toolchain on your host runs on x86 and generates code for x86, while the cross-compilation toolchain runs on x86 and generates code for ARM. Buildroot provides two solutions for the cross-compilation toolchain: * The *internal toolchain backend*, called +Buildroot toolchain+ in the configuration interface. * The *external toolchain backend*, called +External toolchain+ in the configuration interface. The choice between these two solutions is done using the +Toolchain Type+ option in the +Toolchain+ menu. Once one solution has been chosen, a number of configuration options appear, they are detailed in the following sections. [[internal-toolchain-backend]] ==== Internal toolchain backend The _internal toolchain backend_ is the backend where Buildroot builds by itself a cross-compilation toolchain, before building the userspace applications and libraries for your target embedded system. This backend supports several C libraries: http://www.uclibc.org[uClibc], http://www.gnu.org/software/libc/libc.html[glibc] and http://www.musl-libc.org[musl]. Once you have selected this backend, a number of options appear. The most important ones allow to: * Change the version of the Linux kernel headers used to build the toolchain. This item deserves a few explanations. In the process of building a cross-compilation toolchain, the C library is being built. This library provides the interface between userspace applications and the Linux kernel. In order to know how to "talk" to the Linux kernel, the C library needs to have access to the _Linux kernel headers_ (i.e. the +.h+ files from the kernel), which define the interface between userspace and the kernel (system calls, data structures, etc.). Since this interface is backward compatible, the version of the Linux kernel headers used to build your toolchain do not need to match _exactly_ the version of the Linux kernel you intend to run on your embedded system. They only need to have a version equal or older to the version of the Linux kernel you intend to run. If you use kernel headers that are more recent than the Linux kernel you run on your embedded system, then the C library might be using interfaces that are not provided by your Linux kernel. * Change the version of the GCC compiler, binutils and the C library. * Select a number of toolchain options (uClibc only): whether the toolchain should have RPC support (used mainly for NFS), wide-char support, locale support (for internationalization), C++ support or thread support. Depending on which options you choose, the number of userspace applications and libraries visible in Buildroot menus will change: many applications and libraries require certain toolchain options to be enabled. Most packages show a comment when a certain toolchain option is required to be able to enable those packages. If needed, you can further refine the uClibc configuration by running +make uclibc-menuconfig+. Note however that all packages in Buildroot are tested against the default uClibc configuration bundled in Buildroot: if you deviate from this configuration by removing features from uClibc, some packages may no longer build. It is worth noting that whenever one of those options is modified, then the entire toolchain and system must be rebuilt. See xref:full-rebuild[]. Advantages of this backend: * Well integrated with Buildroot * Fast, only builds what's necessary Drawbacks of this backend: * Rebuilding the toolchain is needed when doing +make clean+, which takes time. If you're trying to reduce your build time, consider using the _External toolchain backend_. [[external-toolchain-backend]] ==== External toolchain backend The _external toolchain backend_ allows to use existing pre-built cross-compilation toolchains. Buildroot knows about a number of well-known cross-compilation toolchains (from http://www.linaro.org[Linaro] for ARM, http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/editions/lite-edition/[Sourcery CodeBench] for ARM, x86, x86-64, PowerPC, MIPS and SuperH, https://blackfin.uclinux.org/gf/project/toolchain[Blackfin toolchains from Analog Devices], etc.) and is capable of downloading them automatically, or it can be pointed to a custom toolchain, either available for download or installed locally. Then, you have three solutions to use an external toolchain: * Use a predefined external toolchain profile, and let Buildroot download, extract and install the toolchain. Buildroot already knows about a few CodeSourcery, Linaro, Blackfin and Xilinx toolchains. Just select the toolchain profile in +Toolchain+ from the available ones. This is definitely the easiest solution. * Use a predefined external toolchain profile, but instead of having Buildroot download and extract the toolchain, you can tell Buildroot where your toolchain is already installed on your system. Just select the toolchain profile in +Toolchain+ through the available ones, unselect +Download toolchain automatically+, and fill the +Toolchain path+ text entry with the path to your cross-compiling toolchain. * Use a completely custom external toolchain. This is particularly useful for toolchains generated using crosstool-NG or with Buildroot itself. To do this, select the +Custom toolchain+ solution in the +Toolchain+ list. You need to fill the +Toolchain path+, +Toolchain prefix+ and +External toolchain C library+ options. Then, you have to tell Buildroot what your external toolchain supports. If your external toolchain uses the 'glibc' library, you only have to tell whether your toolchain supports C\++ or not and whether it has built-in RPC support. If your external toolchain uses the 'uClibc' library, then you have to tell Buildroot if it supports RPC, wide-char, locale, program invocation, threads and C++. At the beginning of the execution, Buildroot will tell you if the selected options do not match the toolchain configuration. Our external toolchain support has been tested with toolchains from CodeSourcery and Linaro, toolchains generated by http://crosstool-ng.org[crosstool-NG], and toolchains generated by Buildroot itself. In general, all toolchains that support the 'sysroot' feature should work. If not, do not hesitate to contact the developers. We do not support toolchains or SDK generated by OpenEmbedded or Yocto, because these toolchains are not pure toolchains (i.e. just the compiler, binutils, the C and C++ libraries). Instead these toolchains come with a very large set of pre-compiled libraries and programs. Therefore, Buildroot cannot import the 'sysroot' of the toolchain, as it would contain hundreds of megabytes of pre-compiled libraries that are normally built by Buildroot. We also do not support using the distribution toolchain (i.e. the gcc/binutils/C library installed by your distribution) as the toolchain to build software for the target. This is because your distribution toolchain is not a "pure" toolchain (i.e. only with the C/C++ library), so we cannot import it properly into the Buildroot build environment. So even if you are building a system for a x86 or x86_64 target, you have to generate a cross-compilation toolchain with Buildroot or crosstool-NG. If you want to generate a custom toolchain for your project, that can be used as an external toolchain in Buildroot, our recommendation is definitely to build it with http://crosstool-ng.org[crosstool-NG]. We recommend to build the toolchain separately from Buildroot, and then _import_ it in Buildroot using the external toolchain backend. Advantages of this backend: * Allows to use well-known and well-tested cross-compilation toolchains. * Avoids the build time of the cross-compilation toolchain, which is often very significant in the overall build time of an embedded Linux system. * Not limited to uClibc: glibc and eglibc toolchains are supported. Drawbacks of this backend: * If your pre-built external toolchain has a bug, may be hard to get a fix from the toolchain vendor, unless you build your external toolchain by yourself using Crosstool-NG. ===== External toolchain wrapper When using an external toolchain, Buildroot generates a wrapper program, that transparently passes the appropriate options (according to the configuration) to the external toolchain programs. In case you need to debug this wrapper to check exactly what arguments are passed, you can set the environment variable +BR2_DEBUG_WRAPPER+ to either one of: * +0+, empty or not set: no debug * +1+: trace all arguments on a single line * +2+: trace one argument per line === /dev management On a Linux system, the +/dev+ directory contains special files, called _device files_, that allow userspace applications to access the hardware devices managed by the Linux kernel. Without these _device files_, your userspace applications would not be able to use the hardware devices, even if they are properly recognized by the Linux kernel. Under +System configuration+, +/dev management+, Buildroot offers four different solutions to handle the +/dev+ directory : * The first solution is *Static using device table*. This is the old classical way of handling device files in Linux. With this method, the device files are persistently stored in the root filesystem (i.e. they persist across reboots), and there is nothing that will automatically create and remove those device files when hardware devices are added or removed from the system. Buildroot therefore creates a standard set of device files using a _device table_, the default one being stored in +system/device_table_dev.txt+ in the Buildroot source code. This file is processed when Buildroot generates the final root filesystem image, and the _device files_ are therefore not visible in the +output/target+ directory. The +BR2_ROOTFS_STATIC_DEVICE_TABLE+ option allows to change the default device table used by Buildroot, or to add an additional device table, so that additional _device files_ are created by Buildroot during the build. So, if you use this method, and a _device file_ is missing in your system, you can for example create a +board/<yourcompany>/<yourproject>/device_table_dev.txt+ file that contains the description of your additional _device files_, and then you can set +BR2_ROOTFS_STATIC_DEVICE_TABLE+ to +system/device_table_dev.txt board/<yourcompany>/<yourproject>/device_table_dev.txt+. For more details about the format of the device table file, see xref:makedev-syntax[]. * The second solution is *Dynamic using devtmpfs only*. _devtmpfs_ is a virtual filesystem inside the Linux kernel that has been introduced in kernel 2.6.32 (if you use an older kernel, it is not possible to use this option). When mounted in +/dev+, this virtual filesystem will automatically make _device files_ appear and disappear as hardware devices are added and removed from the system. This filesystem is not persistent across reboots: it is filled dynamically by the kernel. Using _devtmpfs_ requires the following kernel configuration options to be enabled: +CONFIG_DEVTMPFS+ and +CONFIG_DEVTMPFS_MOUNT+. When Buildroot is in charge of building the Linux kernel for your embedded device, it makes sure that those two options are enabled. However, if you build your Linux kernel outside of Buildroot, then it is your responsibility to enable those two options (if you fail to do so, your Buildroot system will not boot). * The third solution is *Dynamic using devtmpfs + mdev*. This method also relies on the _devtmpfs_ virtual filesystem detailed above (so the requirement to have +CONFIG_DEVTMPFS+ and +CONFIG_DEVTMPFS_MOUNT+ enabled in the kernel configuration still apply), but adds the +mdev+ userspace utility on top of it. +mdev+ is a program part of BusyBox that the kernel will call every time a device is added or removed. Thanks to the +/etc/mdev.conf+ configuration file, +mdev+ can be configured to for example, set specific permissions or ownership on a device file, call a script or application whenever a device appears or disappear, etc. Basically, it allows _userspace_ to react on device addition and removal events. +mdev+ can for example be used to automatically load kernel modules when devices appear on the system. +mdev+ is also important if you have devices that require a firmware, as it will be responsible for pushing the firmware contents to the kernel. +mdev+ is a lightweight implementation (with fewer features) of +udev+. For more details about +mdev+ and the syntax of its configuration file, see http://git.busybox.net/busybox/tree/docs/mdev.txt. * The fourth solution is *Dynamic using devtmpfs + eudev*. This method also relies on the _devtmpfs_ virtual filesystem detailed above, but adds the +eudev+ userspace daemon on top of it. +eudev+ is a daemon that runs in the background, and gets called by the kernel when a device gets added or removed from the system. It is a more heavyweight solution than +mdev+, but provides higher flexibility. +eudev+ is a standalone version of +udev+, the original userspace daemon used in most desktop Linux distributions, which is now part of Systemd. For more details, see http://en.wikipedia.org/wiki/Udev. The Buildroot developers recommendation is to start with the *Dynamic using devtmpfs only* solution, until you have the need for userspace to be notified when devices are added/removed, or if firmwares are needed, in which case *Dynamic using devtmpfs + mdev* is usually a good solution. Note that if +systemd+ is chosen as init system, /dev management will be performed by the +udev+ program provided by +systemd+. === init system The _init_ program is the first userspace program started by the kernel (it carries the PID number 1), and is responsible for starting the userspace services and programs (for example: web server, graphical applications, other network servers, etc.). Buildroot allows to use three different types of init systems, which can be chosen from +System configuration+, +Init system+: * The first solution is *BusyBox*. Amongst many programs, BusyBox has an implementation of a basic +init+ program, which is sufficient for most embedded systems. Enabling the +BR2_INIT_BUSYBOX+ will ensure BusyBox will build and install its +init+ program. This is the default solution in Buildroot. The BusyBox +init+ program will read the +/etc/inittab+ file at boot to know what to do. The syntax of this file can be found in http://git.busybox.net/busybox/tree/examples/inittab (note that BusyBox +inittab+ syntax is special: do not use a random +inittab+ documentation from the Internet to learn about BusyBox +inittab+). The default +inittab+ in Buildroot is stored in +system/skeleton/etc/inittab+. Apart from mounting a few important filesystems, the main job the default inittab does is to start the +/etc/init.d/rcS+ shell script, and start a +getty+ program (which provides a login prompt). * The second solution is *systemV*. This solution uses the old traditional _sysvinit_ program, packed in Buildroot in +package/sysvinit+. This was the solution used in most desktop Linux distributions, until they switched to more recent alternatives such as Upstart or Systemd. +sysvinit+ also works with an +inittab+ file (which has a slightly different syntax than the one from BusyBox). The default +inittab+ installed with this init solution is located in +package/sysvinit/inittab+. * The third solution is *systemd*. +systemd+ is the new generation init system for Linux. It does far more than traditional _init_ programs: aggressive parallelization capabilities, uses socket and D-Bus activation for starting services, offers on-demand starting of daemons, keeps track of processes using Linux control groups, supports snapshotting and restoring of the system state, etc. +systemd+ will be useful on relatively complex embedded systems, for example the ones requiring D-Bus and services communicating between each other. It is worth noting that +systemd+ brings a fairly big number of large dependencies: +dbus+, +udev+ and more. For more details about +systemd+, see http://www.freedesktop.org/wiki/Software/systemd. The solution recommended by Buildroot developers is to use the *BusyBox init* as it is sufficient for most embedded systems. *systemd* can be used for more complex situations.
shibajee/buildroot
docs/manual/configure.txt
Text
mit
19,496
// -*- mode:doc; -*- // vim: set syntax=asciidoc: == Contributing to Buildroot There are many ways in which you can contribute to Buildroot: analyzing and fixing bugs, analyzing and fixing package build failures detected by the autobuilders, testing and reviewing patches sent by other developers, working on the items in our TODO list and sending your own improvements to Buildroot or its manual. The following sections give a little more detail on each of these items. If you are interested in contributing to Buildroot, the first thing you should do is to subscribe to the Buildroot mailing list. This list is the main way of interacting with other Buildroot developers and to send contributions to. If you aren't subscribed yet, then refer to xref:community-resources[] for the subscription link. If you are going to touch the code, it is highly recommended to use a git repository of Buildroot, rather than starting from an extracted source code tarball. Git is the easiest way to develop from and directly send your patches to the mailing list. Refer to xref:getting-buildroot[] for more information on obtaining a Buildroot git tree. === Reproducing, analyzing and fixing bugs A first way of contributing is to have a look at the open bug reports in the https://bugs.buildroot.org/buglist.cgi?product=buildroot[Buildroot bug tracker]. As we strive to keep the bug count as small as possible, all help in reproducing, analyzing and fixing reported bugs is more than welcome. Don't hesitate to add a comment to bug reports reporting your findings, even if you don't yet see the full picture. === Analyzing and fixing autobuild failures The Buildroot autobuilders are a set of build machines that continuously run Buildroot builds based on random configurations. This is done for all architectures supported by Buildroot, with various toolchains, and with a random selection of packages. With the large commit activity on Buildroot, these autobuilders are a great help in detecting problems very early after commit. All build results are available at http://autobuild.buildroot.org[], statistics are at http://autobuild.buildroot.org/stats.php[]. Every day, an overview of all failed packages is sent to the mailing list. Detecting problems is great, but obviously these problems have to be fixed as well. Your contribution is very welcome here! There are basically two things that can be done: - Analyzing the problems. The daily summary mails do not contain details about the actual failures: in order to see what's going on you have to open the build log and check the last output. Having someone doing this for all packages in the mail is very useful for other developers, as they can make a quick initial analysis based on this output alone. - Fixing a problem. When fixing autobuild failures, you should follow these steps: . Check if you can reproduce the problem by building with the same configuration. You can do this manually, or use the http://git.buildroot.org/buildroot-test/tree/utils/br-reproduce-build[br-reproduce-build] script that will automatically clone a Buildroot git repository, checkout the correct revision, download and set the right configuration, and start the build. . Analyze the problem and create a fix. . Verify that the problem is really fixed by starting from a clean Buildroot tree and only applying your fix. . Send the fix to the Buildroot mailing list (see xref:submitting-patches[]). In case you created a patch against the package sources, you should also send the patch upstream so that the problem will be fixed in a later release, and the patch in Buildroot can be removed. In the commit message of a patch fixing an autobuild failure, add a reference to the build result directory, as follows: --------------------- Fixes http://autobuild.buildroot.org/results/51000a9d4656afe9e0ea6f07b9f8ed374c2e4069 --------------------- === Reviewing and testing patches With the amount of patches sent to the mailing list each day, the maintainer has a very hard job to judge which patches are ready to apply and which ones aren't. Contributors can greatly help here by reviewing and testing these patches. In the review process, do not hesitate to respond to patch submissions for remarks, suggestions or anything that will help everyone to understand the patches and make them better. Please use internet style replies in plain text emails when responding to patch submissions. To indicate approval of a patch, there are three formal tags that keep track of this approval. To add your tag to a patch, reply to it with the approval tag below the original author's Signed-off-by line. These tags will be picked up automatically by patchwork (see xref:apply-patches-patchwork[]) and will be part of the commit log when the patch is accepted. Tested-by:: Indicates that the patch has been tested successfully. You are encouraged to specify what kind of testing you performed (compile-test on architecture X and Y, runtime test on target A, ...). This additional information helps other testers and the maintainer. Reviewed-by:: Indicates that you code-reviewed the patch and did your best in spotting problems, but you are not sufficiently familiar with the area touched to provide an Acked-by tag. This means that there may be remaining problems in the patch that would be spotted by someone with more experience in that area. Should such problems be detected, your Reviewed-by tag remains appropriate and you cannot be blamed. Acked-by:: Indicates that you code-reviewed the patch and you are familiar enough with the area touched to feel that the patch can be committed as-is (no additional changes required). In case it later turns out that something is wrong with the patch, your Acked-by could be considered inappropriate. The difference between Acked-by and Reviewed-by is thus mainly that you are prepared to take the blame on Acked patches, but not on Reviewed ones. If you reviewed a patch and have comments on it, you should simply reply to the patch stating these comments, without providing a Reviewed-by or Acked-by tag. These tags should only be provided if you judge the patch to be good as it is. It is important to note that neither Reviewed-by nor Acked-by imply that testing has been performed. To indicate that you both reviewed and tested the patch, provide two separate tags (Reviewed/Acked-by and Tested-by). Note also that _any developer_ can provide Tested/Reviewed/Acked-by tags, without exception, and we encourage everyone to do this. Buildroot does not have a defined group of _core_ developers, it just so happens that some developers are more active than others. The maintainer will value tags according to the track record of their submitter. Tags provided by a regular contributor will naturally be trusted more than tags provided by a newcomer. As you provide tags more regularly, your 'trustworthiness' (in the eyes of the maintainer) will go up, but _any_ tag provided is valuable. Buildroot's Patchwork website can be used to pull in patches for testing purposes. Please see xref:apply-patches-patchwork[] for more information on using Buildroot's Patchwork website to apply patches. [[apply-patches-patchwork]] ==== Applying Patches from Patchwork The main use of Buildroot's Patchwork website for a developer is for pulling in patches into their local git repository for testing purposes. When browsing patches in the patchwork management interface, an +mbox+ link is provided at the top of the page. Copy this link address and run the following commands: --------------------- $ git checkout -b <test-branch-name> $ wget -O - <mbox-url> | git am --------------------- Another option for applying patches is to create a bundle. A bundle is a set of patches that you can group together using the patchwork interface. Once the bundle is created and the bundle is made public, you can copy the +mbox+ link for the bundle and apply the bundle using the above commands. === Work on items from the TODO list If you want to contribute to Buildroot but don't know where to start, and you don't like any of the above topics, you can always work on items from the http://elinux.org/Buildroot#Todo_list[Buildroot TODO list]. Don't hesitate to discuss an item first on the mailing list or on IRC. Do edit the wiki to indicate when you start working on an item, so we avoid duplicate efforts. [[submitting-patches]] === Submitting patches [NOTE] _Please, do not attach patches to bugs, send them to the mailing list instead_. If you made some changes to Buildroot and you would like to contribute them to the Buildroot project, proceed as follows. ==== The formatting of a patch We expect patches to be formatted in a specific way. This is necessary to make it easy to review patches, to be able to apply them easily to the git repository, to make it easy to find back in the history how and why things have changed, and to make it possible to use +git bisect+ to locate the origin of a problem. First of all, it is essential that the patch has a good commit message. The commit message should start with a separate line with a brief summary of the change, starting with the name of the affected package. The body of the commit message should describe _why_ this change is needed, and if necessary also give details about _how_ it was done. When writing the commit message, think of how the reviewers will read it, but also think about how you will read it when you look at this change again a few years down the line. Second, the patch itself should do only one change, but do it completely. Two unrelated or weakly related changes should usually be done in two separate patches. This usually means that a patch affects only a single package. If several changes are related, it is often still possible to split them up in small patches and apply them in a specific order. Small patches make it easier to review, and often make it easier to understand afterwards why a change was done. However, each patch must be complete. It is not allowed that the build is broken when only the first but not the second patch is applied. This is necessary to be able to use +git bisect+ afterwards. Of course, while you're doing your development, you're probably going back and forth between packages, and certainly not committing things immediately in a way that is clean enough for submission. So most developers rewrite the history of commits to produce a clean set of commits that is appropriate for submission. To do this, you need to use _interactive rebasing_. You can learn about it https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History[in the Pro Git book]. Sometimes, it is even easier to discard you history with +git reset --soft origin/master+ and select individual changes with +git add -i+ or +git add -p+. Finally, the patch should be signed off. This is done by adding +Signed-off-by: Your Real Name <your@email.address>+ at the end of the commit message. +git commit -s+ does that for you, if configured properly. The +Signed-off-by+ tag means that you publish the patch under the Buildroot license (i.e. GPLv2, except for package patches, which have the upstream license), and that you are allowed to do so. See http://developercertificate.org/[the Developer Certificate of Origin] for details. When adding new packages, you should submit every package in a separate patch. This patch should have the update to +package/Config.in+, the package +Config.in+ file, the +.mk+ file, the +.hash+ file, any init script, and all package patches. If the package has many sub-options, these are sometimes better added as separate follow-up patches. The summary line should be something like +<packagename>: new package+. The body of the commit message can be empty for simple packages, or it can contain the description of the package (like the Config.in help text). If anything special has to be done to build the package, this should also be explained explicitly in the commit message body. When you bump a package to a new version, you should also submit a separate patch for each package. Don't forget to update the +.hash+ file, or add it if it doesn't exist yet. Also don't forget to check if the +_LICENSE+ and +_LICENSE_FILES+ are still valid. The summary line should be something like +<packagename>: bump to version <new version>+. If the new version only contains security updates compared to the existing one, the summary should be +<packagename>: security bump to version <new version>+ and the commit message body should show the CVE numbers that are fixed. If some package patches can be removed in the new version, it should be explained explicitly why they can be removed, preferably with the upstream commit ID. Also any other required changes should be explained explicitly, like configure options that no longer exist or are no longer needed. ==== Preparing a patch series Starting from the changes committed in your local git view, _rebase_ your development branch on top of the upstream tree before generating a patch set. To do so, run: --------------------- $ git fetch --all --tags $ git rebase origin/master --------------------- Now, you are ready to generate then submit your patch set. To generate it, run: --------------------- $ git format-patch -M -n -s -o outgoing origin/master --------------------- This will generate patch files in the +outgoing+ subdirectory, automatically adding the +Signed-off-by+ line. Once patch files are generated, you can review/edit the commit message before submitting them, using your favorite text editor. Lastly, send/submit your patch set to the Buildroot mailing list: --------------------- $ git send-email --to buildroot@buildroot.org outgoing/* --------------------- Note that +git+ should be configured to use your mail account. To configure +git+, see +man git-send-email+ or google it. If you do not use +git send-email+, make sure posted *patches are not line-wrapped*, otherwise they cannot easily be applied. In such a case, fix your e-mail client, or better yet, learn to use +git send-email+. ==== Cover letter If you want to present the whole patch set in a separate mail, add +--cover-letter+ to the +git format-patch+ command (see +man git-format-patch+ for further information). This will generate a template for an introduction e-mail to your patch series. A 'cover letter' may be useful to introduce the changes you propose in the following cases: * large number of commits in the series; * deep impact of the changes in the rest of the project; * RFC footnote:[RFC: (Request for comments) change proposal]; * whenever you feel it will help presenting your work, your choices, the review process, etc. ==== Patch revision changelog When improvements are requested, the new revision of each commit should include a changelog of the modifications between each submission. Note that when your patch series is introduced by a cover letter, an overall changelog may be added to the cover letter in addition to the changelog in the individual commits. The best thing to rework a patch series is by interactive rebasing: +git rebase -i origin/master+. Consult the git manual for more information. When added to the individual commits, this changelog is added when editing the commit message. Below the +Signed-off-by+ section, add +---+ and your changelog. Although the changelog will be visible for the reviewers in the mail thread, as well as in http://patchwork.buildroot.org[patchwork], +git+ will automatically ignores lines below +---+ when the patch will be merged. This is the intended behavior: the changelog is not meant to be preserved forever in the +git+ history of the project. Hereafter the recommended layout: --------------- Patch title: short explanation, max 72 chars A paragraph that explains the problem, and how it manifests itself. If the problem is complex, it is OK to add more paragraphs. All paragraphs should be wrapped at 72 characters. A paragraph that explains the root cause of the problem. Again, more than on paragraph is OK. Finally, one or more paragraphs that explain how the problem is solved. Don't hesitate to explain complex solutions in detail. Signed-off-by: John DOE <john.doe@example.net> --- Changes v2 -> v3: - foo bar (suggested by Jane) - bar buz Changes v1 -> v2: - alpha bravo (suggested by John) - charly delta --------------- Any patch revision should include the version number. The version number is simply composed of the letter +v+ followed by an +integer+ greater or equal to two (i.e. "PATCH v2", "PATCH v3" ...). This can be easily handled with +git format-patch+ by using the option +--subject-prefix+: --------------------- $ git format-patch --subject-prefix "PATCH v4" \ -M -s -o outgoing origin/master --------------------- Since git version 1.8.1, you can also use +-v <n>+ (where <n> is the version number): --------------------- $ git format-patch -v4 -M -s -o outgoing origin/master --------------------- When you provide a new version of a patch, please mark the old one as superseded in http://patchwork.buildroot.org[patchwork]. You need to create an account on http://patchwork.buildroot.org[patchwork] to be able to modify the status of your patches. Note that you can only change the status of patches you submitted yourself, which means the email address you register in http://patchwork.buildroot.org[patchwork] should match the one you use for sending patches to the mailing list. You can also add the +--in-reply-to <message-id>+ option when submitting a patch to the mailing list. The id of the mail to reply to can be found under the "Message Id" tag on http://patchwork.buildroot.org[patchwork]. The advantage of *in-reply-to* is that patchwork will automatically mark the previous version of the patch as superseded. [[reporting-bugs]] === Reporting issues/bugs or getting help Before reporting any issue, please check in xref:community-resources[the mailing list archive] whether someone has already reported and/or fixed a similar problem. However you choose to report bugs or get help, either by opening a bug in the xref:community-resources[bug tracker] or by xref:community-resources[sending a mail to the mailing list], there are a number of details to provide in order to help people reproduce and find a solution to the issue. Try to think as if you were trying to help someone else; in that case, what would you need? Here is a short list of details to provide in such case: * host machine (OS/release) * version of Buildroot * target for which the build fails * package(s) for which the build fails * the command that fails and its output * any information you think that may be relevant Additionally, you should add the +.config+ file (or if you know how, a +defconfig+; see xref:customize-store-buildroot-config[]). If some of these details are too large, do not hesitate to use a pastebin service. Note that not all available pastebin services will preserve Unix-style line terminators when downloading raw pastes. Following pastebin services are known to work correctly: - https://gist.github.com/ - http://code.bulix.org/
shibajee/buildroot
docs/manual/contribute.txt
Text
mit
19,266
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[customize-store-buildroot-config]] === Storing the Buildroot configuration The Buildroot configuration can be stored using the command +make savedefconfig+. This strips the Buildroot configuration down by removing configuration options that are at their default value. The result is stored in a file called +defconfig+. If you want to save it in another place, change the +BR2_DEFCONFIG+ option in the Buildroot configuration itself, or call make with +make savedefconfig BR2_DEFCONFIG=<path-to-defconfig>+. The recommended place to store this defconfig is +configs/<boardname>_defconfig+. If you follow this recommendation, the configuration will be listed in +make help+ and can be set again by running +make <boardname>_defconfig+. Alternatively, you can copy the file to any other place and rebuild with +make defconfig BR2_DEFCONFIG=<path-to-defconfig-file>+. [[customize-store-package-config]] === Storing the configuration of other components The configuration files for BusyBox, the Linux kernel, Barebox, U-Boot and uClibc should be stored as well if changed. For each of these components, a Buildroot configuration option exists to point to an input configuration file, e.g. +BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE+. To store their configuration, set these configuration options to a path where you want to save the configuration files, and then use the helper targets described below to actually store the configuration. As explained in xref:customize-dir-structure[], the recommended path to store these configuration files is +board/<company>/<boardname>/foo.config+. Make sure that you create a configuration file 'before' changing the +BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE+ etc. options. Otherwise, Buildroot will try to access this config file, which doesn't exist yet, and will fail. You can create the configuration file by running +make linux-menuconfig+ etc. Buildroot provides a few helper targets to make the saving of configuration files easier. * +make linux-update-defconfig+ saves the linux configuration to the path specified by +BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE+. It simplifies the config file by removing default values. However, this only works with kernels starting from 2.6.33. For earlier kernels, use +make linux-update-config+. * +make busybox-update-config+ saves the busybox configuration to the path specified by +BR2_PACKAGE_BUSYBOX_CONFIG+. * +make uclibc-update-config+ saves the uClibc configuration to the path specified by +BR2_UCLIBC_CONFIG+. * +make barebox-update-defconfig+ saves the barebox configuration to the path specified by +BR2_TARGET_BAREBOX_CUSTOM_CONFIG_FILE+. * +make uboot-update-defconfig+ saves the U-Boot configuration to the path specified by +BR2_TARGET_UBOOT_CUSTOM_CONFIG_FILE+. * For at91bootstrap3, no helper exists so you have to copy the config file manually to +BR2_TARGET_AT91BOOTSTRAP3_CUSTOM_CONFIG_FILE+.
shibajee/buildroot
docs/manual/customize-configuration.txt
Text
mit
2,965
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[customize-device-permission]] ==== Setting file permissions and ownership and adding custom devices nodes Sometimes it is needed to set specific permissions or ownership on files or device nodes. For example, certain files may need to be owned by root. Since the post-build scripts are not run as root, you cannot do such changes from there unless you use an explicit fakeroot from the post-build script. Instead, Buildroot provides support for so-called _permission tables_. To use this feature, set config option +BR2_ROOTFS_DEVICE_TABLE+ to a space-separated list of permission tables, regular text files following the xref:makedev-syntax[makedev syntax]. If you are using a static device table (i.e. not using +devtmpfs+, +mdev+, or +(e)udev+) then you can add device nodes using the same syntax, in so-called _device tables_. To use this feature, set config option +BR2_ROOTFS_STATIC_DEVICE_TABLE+ to a space-separated list of device tables. As shown in xref:customize-dir-structure[], the recommended location for such files is +board/<company>/<boardname>/+. It should be noted that if the specific permissions or device nodes are related to a specific application, you should set variables +FOO_PERMISSIONS+ and +FOO_DEVICES+ in the package's +.mk+ file instead (see xref:generic-package-reference[]).
shibajee/buildroot
docs/manual/customize-device-permission-tables.txt
Text
mit
1,368
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[customize-dir-structure]] === Recommended directory structure When customizing Buildroot for your project, you will be creating one or more project-specific files that need to be stored somewhere. While most of these files could be placed in _any_ location as their path is to be specified in the Buildroot configuration, the Buildroot developers recommend a specific directory structure which is described in this section. Orthogonal to this directory structure, you can choose _where_ you place this structure itself: either inside the Buildroot tree, or outside of it using +BR2_EXTERNAL+. Both options are valid, the choice is up to you. ----- +-- board/ | +-- <company>/ | +-- <boardname>/ | +-- linux.config | +-- busybox.config | +-- <other configuration files> | +-- post_build.sh | +-- post_image.sh | +-- rootfs_overlay/ | | +-- etc/ | | +-- <some file> | +-- patches/ | +-- foo/ | | +-- <some patch> | +-- libbar/ | +-- <some other patches> | +-- configs/ | +-- <boardname>_defconfig | +-- package/ | +-- <company>/ | +-- Config.in (if not using BR2_EXTERNAL) | +-- <company>.mk (if not using BR2_EXTERNAL) | +-- package1/ | | +-- Config.in | | +-- package1.mk | +-- package2/ | +-- Config.in | +-- package2.mk | +-- Config.in (if using BR2_EXTERNAL) +-- external.mk (if using BR2_EXTERNAL) ------ Details on the files shown above are given further in this chapter. Note: if you choose to place this structure outside of the Buildroot tree using +BR2_EXTERNAL+, the <company> and possibly <boardname> components may be superfluous and can be left out. ==== Implementing layered customizations It is quite common for a user to have several related projects that partly need the same customizations. Instead of duplicating these customizations for each project, it is recommended to use a layered customization approach, as explained in this section. Almost all of the customization methods available in Buildroot, like post-build scripts and root filesystem overlays, accept a space-separated list of items. The specified items are always treated in order, from left to right. By creating more than one such item, one for the common customizations and another one for the really project-specific customizations, you can avoid unnecessary duplication. Each layer is typically embodied by a separate directory inside +board/<company>/+. Depending on your projects, you could even introduce more than two layers. An example directory structure for where a user has two customization layers 'common' and 'fooboard' is: ----- +-- board/ +-- <company>/ +-- common/ | +-- post_build.sh | +-- rootfs_overlay/ | | +-- ... | +-- patches/ | +-- ... | +-- fooboard/ +-- linux.config +-- busybox.config +-- <other configuration files> +-- post_build.sh +-- rootfs_overlay/ | +-- ... +-- patches/ +-- ... ----- For example, if the user has the +BR2_GLOBAL_PATCH_DIR+ configuration option set as: ----- BR2_GLOBAL_PATCH_DIR="board/<company>/common/patches board/<company>/fooboard/patches" ----- then first the patches from the 'common' layer would be applied, followed by the patches from the 'fooboard' layer.
shibajee/buildroot
docs/manual/customize-directory-structure.txt
Text
mit
3,589
// -*- mode:doc -*- ; // vim: set syntax=asciidoc: [[outside-br-custom]] === Keeping customizations outside of Buildroot As already briefly mentioned in xref:customize-dir-structure[], you can place project-specific customizations in two locations: * directly within the Buildroot tree, typically maintaining them using branches in a version control system so that upgrading to a newer Buildroot release is easy. * outside of the Buildroot tree, using the +BR2_EXTERNAL+ mechanism. This mechanism allows to keep package recipes, board support and configuration files outside of the Buildroot tree, while still having them nicely integrated in the build logic. This section explains how to use +BR2_EXTERNAL+. +BR2_EXTERNAL+ is an environment variable that can be used to point to a directory that contains Buildroot customizations. It can be passed to any Buildroot +make+ invocation. It is automatically saved in the hidden +.br-external+ file in the output directory. Thanks to this, there is no need to pass +BR2_EXTERNAL+ at every +make+ invocation. It can however be changed at any time by passing a new value, and can be removed by passing an empty value. .Note The +BR2_EXTERNAL+ path can be either an absolute or a relative path, but if it's passed as a relative path, it is important to note that it is interpreted relative to the main Buildroot source directory, *not* to the Buildroot output directory. Some examples: ----- buildroot/ $ make BR2_EXTERNAL=/path/to/foobar menuconfig ----- From now on, external definitions from the +/path/to/foobar+ directory will be used: ----- buildroot/ $ make buildroot/ $ make legal-info ----- We can switch to another external definitions directory at any time: ----- buildroot/ $ make BR2_EXTERNAL=/where/we/have/barfoo xconfig ----- Or disable the usage of external definitions: ----- buildroot/ $ make BR2_EXTERNAL= xconfig ----- +BR2_EXTERNAL+ allows three different things: * One can store all the board-specific configuration files there, such as the kernel configuration, the root filesystem overlay, or any other configuration file for which Buildroot allows to set its location. The +BR2_EXTERNAL+ value is available within the Buildroot configuration using +$(BR2_EXTERNAL)+. As an example, one could set the +BR2_ROOTFS_OVERLAY+ Buildroot option to +$(BR2_EXTERNAL)/board/<boardname>/overlay/+ (to specify a root filesystem overlay), or the +BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE+ Buildroot option to +$(BR2_EXTERNAL)/board/<boardname>/kernel.config+ (to specify the location of the kernel configuration file). * One can store package recipes (i.e. +Config.in+ and +<packagename>.mk+), or even custom configuration options and make logic. Buildroot automatically includes +$(BR2_EXTERNAL)/Config.in+ to make it appear in the top-level configuration menu, and includes +$(BR2_EXTERNAL)/external.mk+ with the rest of the makefile logic. + .Note Providing +Config.in+ and +external.mk+ is mandatory, but they can be empty. + The main usage of this is to store package recipes. The recommended way to do this is to write a +$(BR2_EXTERNAL)/Config.in+ file that looks like: + ------ source "$BR2_EXTERNAL/package/package1/Config.in" source "$BR2_EXTERNAL/package/package2/Config.in" ------ + Then, have a +$(BR2_EXTERNAL)/external.mk+ file that looks like: + ------ include $(sort $(wildcard $(BR2_EXTERNAL)/package/*/*.mk)) ------ + And then in +$(BR2_EXTERNAL)/package/package1+ and +$(BR2_EXTERNAL)/package/package2+ create normal Buildroot package recipes, as explained in xref:adding-packages[]. If you prefer, you can also group the packages in subdirectories called <boardname> and adapt the above paths accordingly. * One can store Buildroot defconfigs in the +configs+ subdirectory of +$(BR2_EXTERNAL)+. Buildroot will automatically show them in the output of +make list-defconfigs+ and allow them to be loaded with the normal +make <name>_defconfig+ command. They will be visible under the +User-provided configs+' label in the 'make list-defconfigs' output.
shibajee/buildroot
docs/manual/customize-outside-br.txt
Text
mit
4,139
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[customize-packages]] === Adding project-specific packages In general, any new package should be added directly in the +package+ directory and submitted to the Buildroot upstream project. How to add packages to Buildroot in general is explained in full detail in xref:adding-packages[] and will not be repeated here. However, your project may need some proprietary packages that cannot be upstreamed. This section will explain how you can keep such project-specific packages in a project-specific directory. As shown in xref:customize-dir-structure[], the recommended location for project-specific packages is +package/<company>/+. If you are using the +BR2_EXTERNAL+ feature (see xref:outside-br-custom[]) the recommended location is +$(BR2_EXTERNAL)/package/+. However, Buildroot will not be aware of the packages in this location, unless we perform some additional steps. As explained in xref:adding-packages[], a package in Buildroot basically consists of two files: a +.mk+ file (describing how to build the package) and a +Config.in+ file (describing the configuration options for this package). Buildroot will automatically include the +.mk+ files in first-level subdirectories of the +package+ directory (using the pattern +package/\*/*.mk+). If we want Buildroot to include +.mk+ files from deeper subdirectories (like +package/<company>/package1/+) then we simply have to add a +.mk+ file in a first-level subdirectory that includes these additional +.mk+ files. Therefore, create a file +package/<company>/<company>.mk+ with following contents (assuming you have only one extra directory level below +package/<company>/+): ----- include $(sort $(wildcard package/<company>/*/*.mk)) ----- If you are using +BR2_EXTERNAL+, create a file +$(BR2_EXTERNAL)/external.mk+ with following contents (again assuming only one extra level): ----- include $(sort $(wildcard $(BR2_EXTERNAL)/package/*/*.mk)) ----- For the +Config.in+ files, create a file +package/<company>/Config.in+ that includes the +Config.in+ files of all your packages. An exhaustive list has to be provided since wildcards are not supported in the source command of kconfig. For example: ----- source "package/<company>/package1/Config.in" source "package/<company>/package2/Config.in" ----- Include this new file +package/<company>/Config.in+ from +package/Config.in+, preferably in a company-specific menu to make merges with future Buildroot versions easier. If you are using +BR2_EXTERNAL+, create a file +$(BR2_EXTERNAL)/Config.in+ with similar contents: ----- source "$BR2_EXTERNAL/package/package1/Config.in" source "$BR2_EXTERNAL/package/package2/Config.in" ----- You do not have to add an include for this +$(BR2_EXTERNAL)/Config.in+ file as it is included automatically.
shibajee/buildroot
docs/manual/customize-packages.txt
Text
mit
2,816
// -*- mode:doc -*- ; // vim: set syntax=asciidoc: [[customize-patches]] === Adding project-specific patches It is sometimes useful to apply 'extra' patches to packages - on top of those provided in Buildroot. This might be used to support custom features in a project, for example, or when working on a new architecture. The +BR2_GLOBAL_PATCH_DIR+ configuration option can be used to specify a space separated list of one or more directories containing package patches. For a specific version +<packageversion>+ of a specific package +<packagename>+, patches are applied from +BR2_GLOBAL_PATCH_DIR+ as follows: . For every directory - +<global-patch-dir>+ - that exists in +BR2_GLOBAL_PATCH_DIR+, a +<package-patch-dir>+ will be determined as follows: + * +<global-patch-dir>/<packagename>/<packageversion>/+ if the directory exists. + * Otherwise, +<global-patch-dir>/<packagename>+ if the directory exists. . Patches will then be applied from a +<package-patch-dir>+ as follows: + * If a +series+ file exists in the package directory, then patches are applied according to the +series+ file; + * Otherwise, patch files matching +*.patch+ are applied in alphabetical order. So, to ensure they are applied in the right order, it is highly recommended to name the patch files like this: +<number>-<description>.patch+, where +<number>+ refers to the 'apply order'. For information about how patches are applied for a package, see xref:patch-apply-order[] The +BR2_GLOBAL_PATCH_DIR+ option is the preferred method for specifying a custom patch directory for packages. It can be used to specify a patch directory for any package in buildroot. It should also be used in place of the custom patch directory options that are available for packages such as U-Boot and Barebox. By doing this, it will allow a user to manage their patches from one top-level directory. The exception to +BR2_GLOBAL_PATCH_DIR+ being the preferred method for specifying custom patches is +BR2_LINUX_KERNEL_PATCH+. +BR2_LINUX_KERNEL_PATCH+ should be used to specify kernel patches that are available at an URL. *Note:* +BR2_LINUX_KERNEL_PATCH+ specifies kernel patches that are applied after patches available in +BR2_GLOBAL_PATCH_DIR+, as it is done from a post-patch hook of the Linux package.
shibajee/buildroot
docs/manual/customize-patches.txt
Text
mit
2,299
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Customization _after_ the images have been created While post-build scripts (xref:rootfs-custom[]) are run _before_ building the filesystem image, kernel and bootloader, *post-image scripts* can be used to perform some specific actions _after_ all images have been created. Post-image scripts can for example be used to automatically extract your root filesystem tarball in a location exported by your NFS server, or to create a special firmware image that bundles your root filesystem and kernel image, or any other custom action required for your project. To enable this feature, specify a space-separated list of post-image scripts in config option +BR2_ROOTFS_POST_IMAGE_SCRIPT+ (in the +System configuration+ menu). If you specify a relative path, it will be relative to the root of the Buildroot tree. Just like post-build scripts, post-image scripts are run with the main Buildroot tree as current working directory. The path to the +images+ output directory is passed as the first argument to each script. If the config option +BR2_ROOTFS_POST_SCRIPT_ARGS+ is not empty, these arguments will be passed to the script too. All the scripts will be passed the exact same set of arguments, it is not possible to pass different sets of arguments to each script. Again just like for the post-build scripts, the scripts have access to the environment variables +BR2_CONFIG+, +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+, +BUILD_DIR+, +BINARIES_DIR+ and +BASE_DIR+. The post-image scripts will be executed as the user that executes Buildroot, which should normally _not_ be the root user. Therefore, any action requiring root permissions in one of these scripts will require special handling (usage of fakeroot or sudo), which is left to the script developer.
shibajee/buildroot
docs/manual/customize-post-image.txt
Text
mit
1,815
// -*- mode:doc; -*- // vim: set syntax=asciidoc: === Quick guide to storing your project-specific customizations Earlier in this chapter, the different methods for making project-specific customizations have been described. This section will now summarize all this by providing step-by-step instructions to storing your project-specific customizations. Clearly, the steps that are not relevant to your project can be skipped. 1. +make menuconfig+ to configure toolchain, packages and kernel. 1. +make linux-menuconfig+ to update the kernel config, similar for other configuration like busybox, uclibc, ... 1. +mkdir -p board/<manufacturer>/<boardname>+ 1. Set the following options to +board/<manufacturer>/<boardname>/<package>.config+ (as far as they are relevant): * +BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE+ * +BR2_PACKAGE_BUSYBOX_CONFIG+ * +BR2_UCLIBC_CONFIG+ * +BR2_TARGET_AT91BOOTSTRAP3_CUSTOM_CONFIG_FILE+ * +BR2_TARGET_BAREBOX_CUSTOM_CONFIG_FILE+ * +BR2_TARGET_UBOOT_CUSTOM_CONFIG_FILE+ 1. Write the configuration files: * +make linux-update-defconfig+ * +make busybox-update-config+ * +make uclibc-update-config+ * +cp <output>/build/at91bootstrap3-*/.config board/<manufacturer>/<boardname>/at91bootstrap3.config+ * +make barebox-update-defconfig+ * +make uboot-update-defconfig+ 1. Create +board/<manufacturer>/<boardname>/rootfs-overlay/+ and fill it with additional files you need on your rootfs, e.g. +board/<manufacturer>/<boardname>/rootfs-overlay/etc/inittab+. Set +BR2_ROOTFS_OVERLAY+ to +board/<manufacturer>/<boardname>/rootfs-overlay+. 1. Create a post-build script +board/<manufacturer>/<boardname>/post_build.sh+. Set +BR2_ROOTFS_POST_BUILD_SCRIPT+ to +board/<manufacturer>/<boardname>/post_build.sh+ 1. If additional setuid permissions have to be set or device nodes have to be created, create +board/<manufacturer>/<boardname>/device_table.txt+ and add that path to +BR2_ROOTFS_DEVICE_TABLE+. 1. If additional user accounts have to be created, create +board/<manufacturer>/<boardname>/users_table.txt+ and add that path to +BR2_ROOTFS_USERS_TABLES+. 1. To add custom patches to certain packages, set +BR2_GLOBAL_PATCH_DIR+ to +board/<manufacturer>/<boardname>/patches/+ and add your patches for each package in a subdirectory named after the package. Each patch should be called +<packagename>-<num>-<description>.patch+. 1. Specifically for the Linux kernel, there also exists the option +BR2_LINUX_KERNEL_PATCH+ with as main advantage that it can also download patches from a URL. If you do not need this, +BR2_GLOBAL_PATCH_DIR+ is preferred. U-Boot, Barebox, at91bootstrap and at91bootstrap3 also have separate options, but these do not provide any advantage over +BR2_GLOBAL_PATCH_DIR+ and will likely be removed in the future. 1. If you need to add project-specific packages, create +package/<manufacturer>/+ and place your packages in that directory. Create an overall +<manufacturer>.mk+ file that includes the +.mk+ files of all your packages. Create an overall +Config.in+ file that sources the +Config.in+ files of all your packages. Include this +Config.in+ file from Buildroot's +package/Config.in+ file. 1. +make savedefconfig+ to save the buildroot configuration. 1. +cp defconfig configs/<boardname>_defconfig+
shibajee/buildroot
docs/manual/customize-quick-guide.txt
Text
mit
3,377
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[rootfs-custom]] === Customizing the generated target filesystem Besides changing the configuration through +make *config+, there are a few other ways to customize the resulting target filesystem. The two recommended methods, which can co-exist, are root filesystem overlay(s) and post build script(s). Root filesystem overlays (+BR2_ROOTFS_OVERLAY+):: + A filesystem overlay is a tree of files that is copied directly over the target filesystem after it has been built. To enable this feature, set config option +BR2_ROOTFS_OVERLAY+ (in the +System configuration+ menu) to the root of the overlay. You can even specify multiple overlays, space-separated. If you specify a relative path, it will be relative to the root of the Buildroot tree. Hidden directories of version control systems, like +.git+, +.svn+, +.hg+, etc., files called +.empty+ and files ending in +~+ are excluded from the copy. + As shown in xref:customize-dir-structure[], the recommended path for this overlay is +board/<company>/<boardname>/rootfs-overlay+. Post-build scripts (+BR2_ROOTFS_POST_BUILD_SCRIPT+):: + Post-build scripts are shell scripts called 'after' Buildroot builds all the selected software, but 'before' the rootfs images are assembled. To enable this feature, specify a space-separated list of post-build scripts in config option +BR2_ROOTFS_POST_BUILD_SCRIPT+ (in the +System configuration+ menu). If you specify a relative path, it will be relative to the root of the Buildroot tree. + Using post-build scripts, you can remove or modify any file in your target filesystem. You should, however, use this feature with care. Whenever you find that a certain package generates wrong or unneeded files, you should fix that package rather than work around it with some post-build cleanup scripts. + As shown in xref:customize-dir-structure[], the recommended path for this script is +board/<company>/<boardname>/post_build.sh+. + The post-build scripts are run with the main Buildroot tree as current working directory. The path to the target filesystem is passed as the first argument to each script. If the config option +BR2_ROOTFS_POST_SCRIPT_ARGS+ is not empty, these arguments will be passed to the script too. All the scripts will be passed the exact same set of arguments, it is not possible to pass different sets of arguments to each script. + In addition, you may also use these environment variables: - +BR2_CONFIG+: the path to the Buildroot .config file - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see xref:generic-package-reference[] - +BUILD_DIR+: the directory where packages are extracted and built - +BINARIES_DIR+: the place where all binary files (aka images) are stored - +BASE_DIR+: the base output directory Below three more methods of customizing the target filesystem are described, but they are not recommended. Direct modification of the target filesystem:: + For temporary modifications, you can modify the target filesystem directly and rebuild the image. The target filesystem is available under +output/target/+. After making your changes, run +make+ to rebuild the target filesystem image. + This method allows you to do anything to the target filesystem, but if you need to clean your Buildroot tree using +make clean+, these changes will be lost. Such cleaning is necessary in several cases, refer to xref:full-rebuild[] for details. This solution is therefore only useful for quick tests: _changes do not survive the +make clean+ command_. Once you have validated your changes, you should make sure that they will persist after a +make clean+, using a root filesystem overlay or a post-build script. Custom target skeleton (+BR2_ROOTFS_SKELETON_CUSTOM+):: + The root filesystem image is created from a target skeleton, on top of which all packages install their files. The skeleton is copied to the target directory +output/target+ before any package is built and installed. The default target skeleton provides the standard Unix filesystem layout and some basic init scripts and configuration files. + If the default skeleton (available under +system/skeleton+) does not match your needs, you would typically use a root filesystem overlay or post-build script to adapt it. However, if the default skeleton is entirely different than what you need, using a custom skeleton may be more suitable. + To enable this feature, enable config option +BR2_ROOTFS_SKELETON_CUSTOM+ and set +BR2_ROOTFS_SKELETON_CUSTOM_PATH+ to the path of your custom skeleton. Both options are available in the +System configuration+ menu. If you specify a relative path, it will be relative to the root of the Buildroot tree. + This method is not recommended because it duplicates the entire skeleton, which prevents taking advantage of the fixes or improvements brought to the default skeleton in later Buildroot releases. Post-fakeroot scripts (+BR2_ROOTFS_POST_FAKEROOT_SCRIPT+):: + When aggregating the final images, some parts of the process requires root rights: creating device nodes in `/dev`, setting permissions or ownership to files and directories... To avoid requiring actual root rights, Buildroot uses +fakeroot+ to simulate root rights. This is not a complete substitute for actually being root, but is enough for what Buildroot needs. + Post-fakeroot scripts are shell scripts that are called at the 'end' of the fakeroot phase, 'right before' the filesystem image generator is called. As such, they are called in the fakeroot context. + Post-fakeroot scripts can be useful in case you need to tweak the filesystem to do modifications that are usually only available to the root user. + .Note: It is recommended to use the existing mechanisms to set file permissions or create entries in `/dev` (see xref:customize-device-permission[]) or to create users (see xref:customize-users[]) + .Note: The difference between post-build scripts (above) and fakeroot scripts, is that post-build scripts are not called in the fakeroot context. + .Note; Using `fakeroot` is not an absolute substitute for actually being root. `fakeroot` only ever fakes the file access rights and types (regular, block-or-char device...) and uid/gid; these are emulated in-memory. include::customize-device-permission-tables.txt[]
shibajee/buildroot
docs/manual/customize-rootfs.txt
Text
mit
6,422
// -*- mode:doc; -*- // vim: set syntax=asciidoc: [[customize-users]] === Adding custom user accounts Sometimes it is needed to add specific users in the target system. To cover this requirement, Buildroot provides support for so-called _users tables_. To use this feature, set config option +BR2_ROOTFS_USERS_TABLES+ to a space-separated list of users tables, regular text files following the xref:makeuser-syntax[makeusers syntax]. As shown in xref:customize-dir-structure[], the recommended location for such files is +board/<company>/<boardname>/+. It should be noted that if the custom users are related to a specific application, you should set variable +FOO_USERS+ in the package's +.mk+ file instead (see xref:generic-package-reference[]).
shibajee/buildroot
docs/manual/customize-users-tables.txt
Text
mit
752