diff --git a/docs/manual/adding-packages-directory.adoc b/docs/manual/adding-packages-directory.adoc index 03249ca06f..0b7221aae0 100644 --- a/docs/manual/adding-packages-directory.adoc +++ b/docs/manual/adding-packages-directory.adoc @@ -44,13 +44,13 @@ project after an empty line. 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 dependencies on the target in +depends on+ form -4. Any dependencies on the toolchain in +depends on+ form -5. Any dependencies on other packages in +depends on+ form -6. Any dependency of the +select+ form -7. The help keyword and help text. +. The type of option: +bool+, +string+... with the prompt +. If needed, the +default+ value(s) +. Any dependencies on the target in +depends on+ form +. Any dependencies on the toolchain in +depends on+ form +. Any dependencies on other packages in +depends on+ form +. Any dependency of the +select+ form +. 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 diff --git a/docs/manual/adding-packages-gettext.adoc b/docs/manual/adding-packages-gettext.adoc index e9c6968e79..739bed25d5 100644 --- a/docs/manual/adding-packages-gettext.adoc +++ b/docs/manual/adding-packages-gettext.adoc @@ -23,11 +23,11 @@ Due to this, and in order to make sure that Native Language Support is properly handled, packages in Buildroot that can use NLS support should: -1. Ensure NLS support is enabled when +BR2_SYSTEM_ENABLE_NLS=y+. This +. Ensure NLS support is enabled when +BR2_SYSTEM_ENABLE_NLS=y+. This is done automatically for 'autotools' packages and therefore should only be done for packages using other package infrastructures. -1. Add +$(TARGET_NLS_DEPENDENCIES)+ to the package +. Add +$(TARGET_NLS_DEPENDENCIES)+ to the package +_DEPENDENCIES+ variable. This addition should be done unconditionally: the value of this variable is automatically adjusted by the core infrastructure to contain the relevant list of @@ -38,7 +38,7 @@ should: also contains +gettext+ in order to get the full-blown 'gettext' implementation. -1. If needed, add +$(TARGET_NLS_LIBS)+ to the linker flags, so that +. If needed, add +$(TARGET_NLS_LIBS)+ to the linker flags, so that the package gets linked with +libintl+. This is generally not needed with 'autotools' packages as they usually detect automatically that they should link with +libintl+. However, diff --git a/docs/manual/customize-quick-guide.adoc b/docs/manual/customize-quick-guide.adoc index 627ecbacb1..315027c590 100644 --- a/docs/manual/customize-quick-guide.adoc +++ b/docs/manual/customize-quick-guide.adoc @@ -9,11 +9,11 @@ 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 +. +make menuconfig+ to configure toolchain, packages and kernel. +. +make linux-menuconfig+ to update the kernel config, similar for other configuration like busybox, uclibc, ... -1. +mkdir -p board//+ -1. Set the following options to +board///.config+ +. +mkdir -p board//+ +. Set the following options to +board///.config+ (as far as they are relevant): * +BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE+ * +BR2_PACKAGE_BUSYBOX_CONFIG+ @@ -21,7 +21,7 @@ your project can be skipped. * +BR2_TARGET_AT91BOOTSTRAP3_CUSTOM_CONFIG_FILE+ * +BR2_TARGET_BAREBOX_CUSTOM_CONFIG_FILE+ * +BR2_TARGET_UBOOT_CUSTOM_CONFIG_FILE+ -1. Write the configuration files: +. Write the configuration files: * +make linux-update-defconfig+ * +make busybox-update-config+ * +make uclibc-update-config+ @@ -29,38 +29,38 @@ your project can be skipped. board///at91bootstrap3.config+ * +make barebox-update-defconfig+ * +make uboot-update-defconfig+ -1. Create +board///rootfs-overlay/+ and fill it +. Create +board///rootfs-overlay/+ and fill it with additional files you need on your rootfs, e.g. +board///rootfs-overlay/etc/inittab+. Set +BR2_ROOTFS_OVERLAY+ to +board///rootfs-overlay+. -1. Create a post-build script +. Create a post-build script +board///post_build.sh+. Set +BR2_ROOTFS_POST_BUILD_SCRIPT+ to +board///post_build.sh+ -1. If additional setuid permissions have to be set or device nodes have +. If additional setuid permissions have to be set or device nodes have to be created, create +board///device_table.txt+ and add that path to +BR2_ROOTFS_DEVICE_TABLE+. -1. If additional user accounts have to be created, create +. If additional user accounts have to be created, create +board///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 add custom patches to certain packages, set +BR2_GLOBAL_PATCH_DIR+ to +board///patches/+ and add your patches for each package in a subdirectory named after the package. Each patch should be called +--.patch+. -1. Specifically for the Linux kernel, there also exists the option +. 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 +. If you need to add project-specific packages, create +package//+ and place your packages in that directory. Create an overall +.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/_defconfig+ +. +make savedefconfig+ to save the buildroot configuration. +. +cp defconfig configs/_defconfig+