build system overhaul
[platform/upstream/busybox.git] / Makefile.help
1 ### Kernel's one:
2 ### help:
3 ###     @echo  'Cleaning targets:'
4 ###     @echo  '  clean           - remove most generated files but keep the config'
5 ###     @echo  '  mrproper        - remove all generated files + config + various backup files'
6 ###     @echo  ''
7 ###     @echo  'Configuration targets:'
8 ###     @$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
9 ###     @echo  ''
10 ###     @echo  'Other generic targets:'
11 ###     @echo  '  all             - Build all targets marked with [*]'
12 ###     @echo  '* busybox         - Build the bare kernel'
13 ###     @echo  '* modules         - Build all modules'
14 ###     @echo  '  modules_install - Install all modules to INSTALL_MOD_PATH (default: /)'
15 ###     @echo  '  dir/            - Build all files in dir and below'
16 ###     @echo  '  dir/file.[ois]  - Build specified target only'
17 ###     @echo  '  dir/file.ko     - Build module including final link'
18 ###     @echo  '  rpm             - Build a kernel as an RPM package'
19 ###     @echo  '  tags/TAGS       - Generate tags file for editors'
20 ###     @echo  '  cscope          - Generate cscope index'
21 ###     @echo  '  kernelrelease   - Output the release version string'
22 ###     @echo  '  kernelversion   - Output the version stored in Makefile'
23 ###     @echo  ''
24 ###     @echo  'Static analysers'
25 ###     @echo  '  checkstack      - Generate a list of stack hogs'
26 ###     @echo  '  namespacecheck  - Name space analysis on compiled kernel'
27 ###     @echo  ''
28 ###     @echo  'Kernel packaging:'
29 ###     @$(MAKE) $(build)=$(package-dir) help
30 ###     @echo  ''
31 ###     @echo  'Documentation targets:'
32 ###     @$(MAKE) -f $(srctree)/Documentation/DocBook/Makefile dochelp
33 ###     @echo  ''
34 ###     @echo  'Architecture specific targets ($(ARCH)):'
35 ###     @$(if $(archhelp),$(archhelp),\
36 ###             echo '  No architecture specific help defined for $(ARCH)')
37 ###     @echo  ''
38 ###     @$(if $(boards), \
39 ###             $(foreach b, $(boards), \
40 ###             printf "  %-24s - Build for %s\\n" $(b) $(subst _defconfig,,$(b));) \
41 ###             echo '')
42 ### 
43 ###     @echo  '  make V=0|1 [targets] 0 => quiet build (default), 1 => verbose build'
44 ###     @echo  '  make O=dir [targets] Locate all output files in "dir", including .config'
45 ###     @echo  '  make C=1   [targets] Check all c source with $$CHECK (sparse)'
46 ###     @echo  '  make C=2   [targets] Force check of all c source with $$CHECK (sparse)'
47 ###     @echo  ''
48 ###     @echo  'Execute "make" or "make all" to build all targets marked with [*] '
49 ###     @echo  'For further info see the ./README file'
50
51 help:
52         @echo 'Cleaning:'
53         @echo '  clean                  - delete temporary files created by build'
54         @echo '  distclean              - delete all non-source files (including .config)'
55         @echo
56         @echo 'Build:'
57         @echo '  all                    - Executable and documentation'
58         @echo '  busybox                - the swiss-army executable'
59         @echo '  doc                    - docs/BusyBox.{txt,html,1}'
60         @echo '  html                   - create html-based cross-reference'
61         @echo
62         @echo 'Configuration:'
63         @echo '  allnoconfig            - disable all symbols in .config'
64         @echo '  allyesconfig           - enable all symbols in .config (see defconfig)'
65         @echo '  allbareconfig          - enable all applets without any sub-features'
66         @echo '  config         - text based configurator (of last resort)'
67         @echo '  defconfig              - set .config to largest generic configuration'
68         @echo '  menuconfig             - interactive curses-based configurator'
69         @echo '  oldconfig              - resolve any unresolved symbols in .config'
70         @echo '  hosttools              - build sed for the host.'
71         @echo '                           You can use these commands if the commands on the host'
72         @echo '                           is unusable. Afterwards use it like:'
73         @echo '                   make SED="$(objtree)/sed"'
74         @echo
75         @echo 'Installation:'
76         @echo '  install                - install busybox into $(PREFIX)'
77         @echo '  uninstall'
78         @echo
79         @echo 'Development:'
80         @echo '  baseline               - create busybox_old for bloatcheck.'
81         @echo '  bloatcheck             - show size difference between old and new versions'
82         @echo '  check                  - run the test suite for all applets'
83         @echo '  checkhelp              - check for missing help-entries in Config.in'
84         @echo '  randconfig             - generate a random configuration'
85         @echo '  release                - create a distribution tarball'
86         @echo '  sizes                  - show size of all enabled busybox symbols'
87         @echo '  objsizes               - show size of each .o object built'
88         @echo