cirros-testvm/src-cirros/buildroot-2015.05/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
  38 .Cleaning:
  39
  40 Explicit cleaning is required when any of the architecture or toolchain
  41 configuration options are changed.
  42
  43 To delete all build products (including build directories, host, staging
  44 and target trees, the images and the toolchain):
  45
  46 --------------------
  47  $ make clean
  48 --------------------
  49
  50 .Generating the manual:
  51
  52 The present manual sources are located in the 'docs/manual' directory.
  53 To generate the manual:
  54
  55 ---------------------------------
  56  $ make manual-clean
  57  $ make manual
  58 ---------------------------------
  59
  60 The manual outputs will be generated in 'output/docs/manual'.
  61
  62 .Notes
  63 - A few tools are required to build the documentation (see:
  64   xref:requirement-optional[]).
  65
  66 .Resetting Buildroot for a new target:
  67
  68 To delete all build products as well as the configuration:
  69
  70 --------------------
  71  $ make distclean
  72 --------------------
  73
  74 .Notes
  75 If +ccache+ is enabled, running +make clean+ or +distclean+ does
  76 not empty the compiler cache used by Buildroot. To delete it, refer
  77 to xref:ccache[].