doc: documented DBG=1
[k8jam.git] / defaults / Jambase.help
blob2367b67c4e657f88f4e9c0927756c8884be07e63
2 # 'help*' targets
5 rule ShowHelpProfile {
6   NotFile help-profile ;
7   Always help-profile ;
8   AShowHelpProfile help-profile ;
10 actions quietly AShowHelpProfile {
11   echo "profile flags:"
12   echo "  DEBUG=1       -- debug build"
13   echo "  OPT_SPEED=1   -- optimize for speed"
14   echo "  OPT_SIZE=1    -- optimize for size"
15   echo "  OPT=speed     -- optimize for speed"
16   echo "  OPT=size      -- optimize for size"
17   echo "  VALGRIND=1    -- do not strip debug info"
18   echo "  NO_WARNINGS=1 -- do not add '-Wall' flag"
19   echo "  USE_CLANG=1   -- use clang instead of gcc"
20   echo "WARNING: DON'T FORGET TO DO 'jam clean' before building with new flags!"
22 ShowHelpProfile ;
24 rule -ShowHelp- {
25   NotFile help ;
26   Always help ;
27   AShowHelp help ;
28   #AShowHelpProfile help ;
30 actions quietly AShowHelp {
31   echo "WARNING: default help; override 'actions AShowHelp' definition to customize 'help' target!"
32   echo "usage: jam [target] [flags]"
33   echo "tagets:"
34   echo "  jam              -- build project"
35   echo "  jam all          -- build project"
36   echo "  jam clean        -- do cleanup"
37   echo "  jam help         -- show this help"
38   echo "  jam help-profile -- show help for building profiles"
39   echo "  jam gen-boiler   -- generate 'boilerplate' jam files"
40   echo "                      use FORCE=1 to regenerate"
41   echo "                      use MAIN=name to specify name"
43 -ShowHelp- ;