docs/manual/make-tips.txt

   1 // -*- mode:doc; -*-
   2 // vim: set syntax=asciidoc:
   3
   4 [[make-tips]]
   5 === 'make' tips
   6
   7 This is a collection of tips that help you make the most of Buildroot.
   8
   9 .Display all commands executed by make:
  10
  11 --------------------
  12  $ make V=1 <target>
  13 --------------------
  14
  15 .Display the list of boards with a defconfig:
  16
  17 --------------------
  18  $ make list-defconfigs
  19 --------------------
  20
  21 .Display all available targets:
  22
  23 --------------------
  24  $ make help
  25 --------------------
  26
  27 Not all targets are always available,
  28 some settings in the +.config+ file may hide some targets:
  29
  30 * +busybox-menuconfig+ only works when +busybox+ is enabled;
  31 * +linux-menuconfig+ and +linux-savedefconfig+ only work when
  32   +linux+ is enabled;
  33 * +uclibc-menuconfig+ is only available when the uClibc C library is
  34   selected in the internal toolchain backend;
  35 * +barebox-menuconfig+ and +barebox-savedefconfig+ only work when the
  36   +barebox+ bootloader is enabled.
  37 * +uboot-menuconfig+ and +uboot-savedefconfig+ only work when the
  38   +U-Boot+ bootloader is enabled.
  39
  40 .Cleaning:
  41
  42 Explicit cleaning is required when any of the architecture or toolchain
  43 configuration options are changed.
  44
  45 To delete all build products (including build directories, host, staging
  46 and target trees, the images and the toolchain):
  47
  48 --------------------
  49  $ make clean
  50 --------------------
  51
  52 .Generating the manual:
  53
  54 The present manual sources are located in the 'docs/manual' directory.
  55 To generate the manual:
  56
  57 ---------------------------------
  58  $ make manual-clean
  59  $ make manual
  60 ---------------------------------
  61
  62 The manual outputs will be generated in 'output/docs/manual'.
  63
  64 .Notes
  65 - A few tools are required to build the documentation (see:
  66   xref:requirement-optional[]).
  67
  68 .Resetting Buildroot for a new target:
  69
  70 To delete all build products as well as the configuration:
  71
  72 --------------------
  73  $ make distclean
  74 --------------------
  75
  76 .Notes
  77 If +ccache+ is enabled, running +make clean+ or +distclean+ does
  78 not empty the compiler cache used by Buildroot. To delete it, refer
  79 to xref:ccache[].