diff --git a/docs/Developer-Guide_Build-Options.md b/docs/Developer-Guide_Build-Options.md index e8d1f812..c9901dcd 100644 --- a/docs/Developer-Guide_Build-Options.md +++ b/docs/Developer-Guide_Build-Options.md @@ -7,13 +7,13 @@ These parameters are meant to be applied to the `./compile.sh` command. They are - **KERNEL_ONLY** ( yes | no ): - yes: compiles only kernel, U-Boot and other packages for installation on existing Armbian system - no: build complete OS image for writing to SD card - - leave empty to display selection dialog each time - + - leave empty to display selection dialog each time + - **KERNEL_CONFIGURE** ( yes | no ): - yes: Automatically call kernel's `make menuconfig` (add or remove modules or features) - no: Use provided kernel configuration provided by Armbian - - leave empty to display selection dialog each time - + - leave empty to display selection dialog each time + - **CLEAN_LEVEL** (comma-separated list): defines what should be cleaned. Default value is `"make,debs"` - clean sources and remove all packages. Changing this option can be useful when rebuilding images or building more than one image - make: execute `make clean` for selected kernel and U-Boot sources - images: delete `output/images` (complete OS images) @@ -22,47 +22,47 @@ These parameters are meant to be applied to the `./compile.sh` command. They are - cache: delete `cache/rootfs` (rootfs cache) - oldcache: remove old `cache/rootfs` except for the newest eight files - sources: delete `cache/sources` (all downloaded sources) - - extras: delete additional packages for current release in `output/debs/extra` - + - extras: delete additional packages for current release in `output/debs/extra` + - **REPOSITORY_INSTALL** (comma-separated list): list of core packages which will be installed from repository - Available options: `u-boot`, `kernel`, `bsp`, `armbian-config`, `armbian-firmware` - - Set to "" to use packages one from local output or build if not availabe - + - Set to "" to use packages one from local output or build if not available + - **KERNEL\_KEEP\_CONFIG** ( yes | no ): - yes: use kernel config file from previous compilation for the same branch, device family and version - - no: use default or user-provided config file - + - no: use default or user-provided config file + - **BUILD_MINIMAL** ( yes ): - yes: build bare CLI image suitable for application deployment. This option is **not compatible** with `BUILD_DESKTOP="yes"` and `BUILD_EXTERNAL="yes"` - - leave empty to install default CLI package selection - + - leave empty to install default CLI package selection + - **BUILD_DESKTOP** ( yes | no ): - yes: build image with minimal desktop environment - - no: build image with console interface only - + - no: build image with console interface only + - **EXTERNAL** ( yes | no ): - - yes: compile and install extra applications and firmware - + - yes: compile and install extra applications and firmware + - **BSPFREEZE** ( yes | no ): - - yes: freeze (from update) armbian packages when building images (U-Boot, kernel, DTB) - + - yes: freeze (from update) armbian packages when building images (U-Boot, kernel, DTB) + - **INSTALL_HEADERS** (no|yes): - - yes: install kernel headers - + - yes: install kernel headers + - **EXTERNAL_NEW** ( no | prebuilt | compile ): - prebuilt: install extra applications from repository - - compile: compile extra applications in chroot - + - compile: compile extra applications in chroot + - **CREATE_PATCHES** ( yes | no ): - yes: prompt right before the compilation starts to make changes to the source code, separate for U-Boot and kernel, and will create patch files out of this. If you want these patches are included in the normal run, you need to copy them to their appropriate directories. - - no: will not do what is described above and simply builds without interruption - -- **BUILD_ALL** ( yes | no | demo ): cycle through all available board and kernel configurations and make images for all combinations + - no: will not do what is described above and simply builds without interruption + +- **BUILD_ALL** ( yes | no | demo ): cycle through all available board and kernel configurations and make images for all combinations - **LIB_TAG** ( master | "branchname" ): - - set to `master` to compile from the master branch (default) - - set to another "branchname" to compile from any other branch available. Check [here](https://github.com/armbian/build/branches) for available branches. - + - set to `master` to compile from the master branch (default) + - set to another "branchname" to compile from any other branch available. Check [here](https://github.com/armbian/build/branches) for available branches + - **CARD_DEVICE** ( /dev/sdX ): set to the device of your SD card. The image will be burned and verified using Etcher for CLI. - **CRYPTROOT_ENABLE** ( yes | no ): enable LUKS encrypted rootfs @@ -71,14 +71,14 @@ These parameters are meant to be applied to the `./compile.sh` command. They are - `CRYPTROOT_SSH_UNLOCK_PORT=2222` optional - `CRYPTROOT_PARAMETERS="custom cryptsetup options"` optional - **Note:** This function might not work well with all distributions. Debian Buster and Stretch were tested. For building under Docker you have to use privileged mode which can be enable in `userpatches/config-docker`. - - **Warning:** This feature was added as community contribution and mostly functional. Under some circumstances though the prompt will not be shown. Therefore it should be considered experimental. Check [here](https://github.com/armbian/build/commit/681e58b6689acda6a957e325f12e7b748faa8330) and [here](https://github.com/armbian/build/issues/1183) - - + - **Warning:** This feature was added as community contribution and mostly functional. Under some circumstances though the prompt will not be shown. Therefore it should be considered experimental. Check [here](https://github.com/armbian/build/commit/681e58b6689acda6a957e325f12e7b748faa8330) and [here](https://github.com/armbian/build/issues/1183) + + ## Hidden options to minimize user input for build automation: - **BOARD** ( `string` ): set name of board manually to skip dialog prompt - **BRANCH** ( legacy | current | dev ): set kernel and U-Boot branch manually to skip dialog prompt; some options may not be available for all devices -- **RELEASE** ( stretch | buster | bionic | focal | bullseye ): set OS release manually to skip dialog prompt; use this option with `KERNEL_ONLY=yes` to create board support package - +- **RELEASE** ( stretch | buster | bionic | focal | bullseye ): set OS release manually to skip dialog prompt; use this option with `KERNEL_ONLY=yes` to create board support package + ## Hidden options for advanced users (default values are marked **bold**): - **EXPERT** ( yes | **no** ): Show development features in interactive mode - **USERPATCHES_PATH** ( **userpatches/** ): set alternate path for location of `userpatches` folder