LUFA/Build/lufa.core.in

   1 #
   2 #             LUFA Library
   3 #     Copyright (C) Dean Camera, 2012.
   4 #
   5 #  dean [at] fourwalledcubicle [dot] com
   6 #           www.lufa-lib.org
   7 #
   8
   9 LUFA_BUILD_MODULES        += CORE
  10 LUFA_BUILD_TARGETS        += help list_targets list_modules list_mandatory list_optional
  11 LUFA_BUILD_MANDATORY_VARS +=
  12 LUFA_BUILD_OPTIONAL_VARS  +=
  13
  14 # -----------------------------------------------------------------------------
  15 #               LUFA Core Buildsystem Makefile Module.
  16 # -----------------------------------------------------------------------------
  17 # DESCRIPTION:
  18 #   Provides a set of core build targets for the LUFA buildsystem
  19 # -----------------------------------------------------------------------------
  20 # TARGETS:
  21 #
  22 #    help                      - Build system help
  23 #    list_targets              - List all build targets
  24 #    list_modules              - List all build modules
  25 #    list_mandatory            - List all mandatory make variables required by
  26 #                                the included build modules of the application
  27 #    list_optional             - List all optional make variables required by
  28 #                                the included build modules of the application
  29 #
  30 # MANDATORY PARAMETERS:
  31 #
  32 #    (None)
  33 #
  34 # OPTIONAL PARAMETERS:
  35 #
  36 #    (None)
  37 #
  38 # -----------------------------------------------------------------------------
  39
  40 # Build sorted and filtered lists of the included build module data
  41 SORTED_LUFA_BUILD_MODULES  = $(sort $(LUFA_BUILD_MODULES))
  42 SORTED_LUFA_BUILD_TARGETS  = $(sort $(LUFA_BUILD_TARGETS))
  43 SORTED_LUFA_MANDATORY_VARS = $(sort $(LUFA_BUILD_MANDATORY_VARS))
  44 SORTED_LUFA_OPTIONAL_VARS  = $(filter-out $(SORTED_LUFA_MANDATORY_VARS), $(sort $(LUFA_BUILD_OPTIONAL_VARS)))
  45
  46 help:
  47         @echo "==================================================================="
  48         @echo "                       LUFA Build System 2.0                       "
  49         @echo "      (C) Dean Camera, 2012 { dean @ fourwalledcubicle . com }     "
  50         @echo "==================================================================="
  51         @echo "DESCRIPTION:                                                       "
  52         @echo " This build system is a set of makefile modules for (GNU) Make, to "
  53         @echo " provide a simple system for building LUFA powered applications.   "
  54         @echo " Each makefile module can be included from within a user makefile, "
  55         @echo " to expose the build rules documented in the comments at the top of"
  56         @echo " each build module.                                                "
  57         @echo "                                                                   "
  58         @echo "USAGE:                                                             "
  59         @echo " To execute a rule, define all variables indicated in the desired  "
  60         @echo " module as a required parameter before including the build module  "
  61         @echo " in your project makefile. Parameters marked as optional will      "
  62         @echo " assume a default value in the modules if not user-assigned.       "
  63         @echo "                                                                   "
  64         @echo " By default the target output shows both a friendly summary, as    "
  65         @echo " well as the actual invoked command. To suppress the output of the "
  66         @echo " invoked commands and show only the friendly command output, run   "
  67         @echo " make with the \"-s\" switch added before the target(s).           "
  68         @echo "==================================================================="
  69         @echo "  Currently used build system modules in this application:         "
  70         @echo "                                                                   "
  71         @printf " %b" "$(SORTED_LUFA_BUILD_MODULES:%=   - %\n)"
  72         @echo "                                                                   "
  73         @echo "                                                                   "
  74         @echo "  Currently available build targets in this application:           "
  75         @echo "                                                                   "
  76         @printf " %b" "$(SORTED_LUFA_BUILD_TARGETS:%=   - %\n)"
  77         @echo "                                                                   "
  78         @echo "                                                                   "
  79         @echo "  Mandatory variables required by the selected build Modules:      "
  80         @echo "                                                                   "
  81         @printf " %b" "$(SORTED_LUFA_MANDATORY_VARS:%=   - %\n)"
  82         @echo "                                                                   "
  83         @echo "                                                                   "
  84         @echo "  Optional variables required by the selected build Modules:       "
  85         @echo "                                                                   "
  86         @printf " %b" "$(SORTED_LUFA_OPTIONAL_VARS:%=   - %\n)"
  87         @echo "                                                                   "
  88         @echo "==================================================================="
  89         @echo "        The LUFA BuildSystem 2.0 - Powered By Unicorns (tm)        "
  90         @echo "==================================================================="
  91
  92 list_modules:
  93         @echo Currently Used Build System Modules: $(SORTED_LUFA_BUILD_MODULES)
  94
  95 list_targets:
  96         @echo Currently Available Build Targets: $(SORTED_LUFA_BUILD_TARGETS)
  97
  98 list_mandatory:
  99         @echo Mandatory Variables for Included Modules: $(SORTED_LUFA_MANDATORY_VARS)
 100
 101 list_optional:
 102         @echo Optional Variables for Included Modules: $(SORTED_LUFA_OPTIONAL_VARS)
 103
 104 # Disable default in-built make rules (those that are needed are explicitly
 105 # defined, and doing so has performance benefits when recursively building)
 106 .SUFFIXES:
 107
 108 # Phony build targets for this module
 109 .PHONY: help list_modules list_targets list_mandatory list_optional