diff options
Diffstat (limited to 'docs/manual')
| -rw-r--r-- | docs/manual/adding-board-support.txt | 37 | ||||
| -rw-r--r-- | docs/manual/customize-store.txt | 36 | ||||
| -rw-r--r-- | docs/manual/manual.txt | 2 |
3 files changed, 39 insertions, 36 deletions
diff --git a/docs/manual/adding-board-support.txt b/docs/manual/adding-board-support.txt new file mode 100644 index 0000000000..88fd290f6b --- /dev/null +++ b/docs/manual/adding-board-support.txt @@ -0,0 +1,37 @@ +// -*- mode:doc; -*- +// vim: set syntax=asciidoc: + +[[customize-store-board-support]] +== Creating your own board support + +Creating your own board support in Buildroot allows users of a +particular hardware platform to easily build a system that is known to +work. + +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. diff --git a/docs/manual/customize-store.txt b/docs/manual/customize-store.txt index d557902ba8..9c87f625f9 100644 --- a/docs/manual/customize-store.txt +++ b/docs/manual/customize-store.txt @@ -66,42 +66,6 @@ configuration files easier. file manually to +BR2_TARGET_AT91BOOTSTRAP3_CUSTOM_CONFIG_FILE+. -[[customize-store-board-support]] -=== Creating your own board support - -Creating your own board support in Buildroot allows users of a -particular hardware platform to easily build a system that is known to -work. - -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. - - === Step-by-step instructions for storing configuration To store the configuration for a specific product, device or diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt index df34f014f2..3c531e3738 100644 --- a/docs/manual/manual.txt +++ b/docs/manual/manual.txt @@ -52,6 +52,8 @@ include::how-buildroot-works.txt[] include::writing-rules.txt[] +include::adding-board-support.txt[] + include::adding-packages.txt[] include::patch-policy.txt[] |
