make-tips.txt 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. // -*- mode:doc; -*-
  2. // vim: set syntax=asciidoc:
  3. [[make-tips]]
  4. === 'make' tips
  5. This is a collection of tips that help you make the most of Buildroot.
  6. .Configuration searches:
  7. The +make *config+ commands offer a search tool. Read the help message in
  8. the different frontend menus to know how to use it:
  9. * in _menuconfig_, the search tool is called by pressing +/+;
  10. * in _xconfig_, the search tool is called by pressing +Ctrl+ + +f+.
  11. The result of the search shows the help message of the matching items.
  12. .Display all commands executed by make:
  13. --------------------
  14. $ make V=1 <target>
  15. --------------------
  16. .Display all available targets:
  17. --------------------
  18. $ make help
  19. --------------------
  20. Not all targets are always available,
  21. some settings in the +.config+ file may hide some targets:
  22. * +busybox-menuconfig+ only works when +busybox+ is enabled;
  23. * +linux-menuconfig+ and +linux-savedefconfig+ only work when
  24. +linux+ is enabled;
  25. * +uclibc-menuconfig+ is only available when the uClibc C library is
  26. selected in the internal toolchain backend;
  27. * +barebox-menuconfig+ and +barebox-savedefconfig+ only work when the
  28. +barebox+ bootloader is enabled.
  29. .Cleaning:
  30. Explicit cleaning is required when any of the architecture or toolchain
  31. configuration options are changed.
  32. To delete all build products (including build directories, host, staging
  33. and target trees, the images and the toolchain):
  34. --------------------
  35. $ make clean
  36. --------------------
  37. .Generating the manual:
  38. The present manual sources are located in the 'docs/manual' directory.
  39. To generate the manual:
  40. ---------------------------------
  41. $ make manual-clean
  42. $ make manual
  43. ---------------------------------
  44. The manual outputs will be generated in 'output/docs/manual'.
  45. .Notes
  46. - A few tools are required to build the documentation (see:
  47. xref:requirement-optional[]).
  48. .Resetting Buildroot for a new target:
  49. To delete all build products as well as the configuration:
  50. --------------------
  51. $ make distclean
  52. --------------------
  53. .Notes
  54. If +ccache+ is enabled, running +make clean+ or +distclean+ does
  55. not empty the compiler cache used by Buildroot. To delete it, refer
  56. to xref:ccache[].