samples/samples.mk
author "Yann E. MORIN" <yann.morin.1998@free.fr>
Tue Jan 22 00:32:38 2013 +0100 (2013-01-22)
changeset 3168 9b991363c01c
parent 3012 95173b196a88
child 3171 15f1160573a4
permissions -rw-r--r--
samples: check if update is needed

Add a ct-ng action to check if samples needs being updated.
This will be usefull when the config options change.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
     1 # Makefile to manage samples
     2 
     3 # ----------------------------------------------------------
     4 # Build the list of available samples
     5 CT_TOP_SAMPLES := $(patsubst $(CT_TOP_DIR)/samples/%/crosstool.config,%,$(wildcard $(CT_TOP_DIR)/samples/*/crosstool.config))
     6 CT_LIB_SAMPLES := $(filter-out $(CT_TOP_SAMPLES),$(patsubst $(CT_LIB_DIR)/samples/%/crosstool.config,%,$(wildcard $(CT_LIB_DIR)/samples/*/crosstool.config)))
     7 CT_SAMPLES := $(shell echo $(sort $(CT_TOP_SAMPLES) $(CT_LIB_SAMPLES))  \
     8                       |$(sed) -r -e 's/ /\n/g;'                         \
     9                       |$(sed) -r -e 's/(.*),(.*)/\2,\1/;'               \
    10                       |sort                                             \
    11                       |$(sed) -r -e 's/(.*),(.*)/\2,\1/;'               \
    12                )
    13 
    14 # ----------------------------------------------------------
    15 # This part deals with the samples help entries
    16 
    17 help-config::
    18 	@echo  '  saveconfig         - Save current config as a preconfigured target'
    19 
    20 help-samples::
    21 	@echo  '  list-samples       - prints the list of all samples (for scripting)'
    22 	@echo  '  show-<sample>      - show a brief overview of <sample> (list with list-samples)'
    23 	@echo  '  <sample>           - preconfigure crosstool-NG with <sample> (list with list-samples)'
    24 	@echo  '  build-all[.#]      - Build *all* samples (list with list-samples) and install in'
    25 	@echo  '                       $${CT_PREFIX} (which you must set)'
    26 
    27 help-distrib::
    28 	@echo  '  wiki-samples       - Print a DokuWiki table of samples'
    29 
    30 help-env::
    31 	@echo  '  CT_PREFIX=dir      - install samples in dir (see action "build-all", above).'
    32 
    33 # ----------------------------------------------------------
    34 # This part deals with printing samples information
    35 
    36 # Print the details of current configuration
    37 PHONY += show-config
    38 show-config: .config
    39 	@cp .config .config.sample
    40 	@$(CT_LIB_DIR)/scripts/showSamples.sh -v current
    41 	@rm -f .config.sample
    42 
    43 # Prints the details of a sample
    44 PHONY += $(patsubst %,show-%,$(CT_SAMPLES))
    45 $(patsubst %,show-%,$(CT_SAMPLES)): config_files
    46 	@KCONFIG_CONFIG=$$(pwd)/.config.sample	\
    47 	    $(CONF) --defconfig=$(call sample_dir,$(patsubst show-%,%,$(@)))/crosstool.config   \
    48 	            $(KCONFIG_TOP) >/dev/null
    49 	@$(CT_LIB_DIR)/scripts/showSamples.sh -v $(patsubst show-%,%,$(@))
    50 	@rm -f .config.sample
    51 
    52 # Prints the details of all samples
    53 PHONY += show-all
    54 show-all: $(patsubst %,show-%,$(CT_SAMPLES))
    55 
    56 # print the list of all available samples
    57 PHONY += list-samples
    58 list-samples: list-samples-pre $(patsubst %,list-%,$(CT_SAMPLES))
    59 	@echo ' L (Local)       : sample was found in current directory'
    60 	@echo ' G (Global)      : sample was installed with crosstool-NG'
    61 	@echo ' X (EXPERIMENTAL): sample may use EXPERIMENTAL features'
    62 	@echo ' B (BROKEN)      : sample is currently broken'
    63 
    64 PHONY += list-samples-pre
    65 list-samples-pre: FORCE
    66 	@echo 'Status  Sample name'
    67 
    68 PHONY += $(patsubst %,list-%,$(CT_SAMPLES))
    69 $(patsubst %,list-%,$(CT_SAMPLES)): config_files
    70 	@KCONFIG_CONFIG=$$(pwd)/.config.sample	\
    71 	    $(CONF) --defconfig=$(call sample_dir,$(patsubst list-%,%,$(@)))/crosstool.config   \
    72 	            $(KCONFIG_TOP) >/dev/null
    73 	@$(CT_LIB_DIR)/scripts/showSamples.sh $(patsubst list-%,%,$(@))
    74 	@rm -f .config.sample
    75 
    76 PHONY += list-samples-short
    77 list-samples-short: FORCE
    78 	$(SILENT)for s in $(CT_SAMPLES); do \
    79 	    printf "%s\n" "$${s}";          \
    80 	done
    81 
    82 # Check one sample
    83 PHONY += $(patsubst %,check-%,$(CT_SAMPLES))
    84 $(patsubst %,check-%,$(CT_SAMPLES)): config_files
    85 	@export KCONFIG_CONFIG=$$(pwd)/.config.sample;                                  \
    86 	 CT_NG_SAMPLE=$(call sample_dir,$(patsubst check-%,%,$(@)))/crosstool.config;   \
    87 	 $(CONF) --defconfig=$${CT_NG_SAMPLE} $(KCONFIG_TOP) >/dev/null;                \
    88 	 $(CONF) --savedefconfig=$$(pwd)/.defconfig $(KCONFIG_TOP) >/dev/null;          \
    89 	 old_sha1=$$( sha1sum "$${CT_NG_SAMPLE}" |cut -d ' ' -f 1 );                    \
    90 	 new_sha1=$$( sha1sum .defconfig |cut -d ' ' -f 1 );                            \
    91 	 if [ $${old_sha1} != $${new_sha1} ]; then                                      \
    92 	    echo "$(patsubst check-%,%,$(@)) needs update";                             \
    93 	 fi
    94 	@rm -f .config.sample* .defconfig
    95 
    96 check-samples: $(patsubst %,check-%,$(CT_SAMPLES))
    97 
    98 PHONY += wiki-samples
    99 wiki-samples: wiki-samples-pre $(patsubst %,wiki-%,$(CT_SAMPLES)) wiki-samples-post
   100 
   101 wiki-samples-pre: FORCE
   102 	$(SILENT)$(CT_LIB_DIR)/scripts/showSamples.sh -w
   103 
   104 wiki-samples-post: FORCE
   105 	$(SILENT)$(CT_LIB_DIR)/scripts/showSamples.sh -W $(CT_SAMPLES)
   106 
   107 $(patsubst %,wiki-%,$(CT_SAMPLES)): config_files
   108 	$(SILENT)KCONFIG_CONFIG=$$(pwd)/.config.sample	\
   109 	    $(CONF) --defconfig=$(call sample_dir,$(patsubst wiki-%,%,$(@)))/crosstool.config   \
   110 	            $(KCONFIG_TOP) >/dev/null
   111 	$(SILENT)$(CT_LIB_DIR)/scripts/showSamples.sh -w $(patsubst wiki-%,%,$(@))
   112 	$(SILENT)rm -f .config.sample
   113 
   114 # ----------------------------------------------------------
   115 # This part deals with saving/restoring samples
   116 
   117 PHONY += samples
   118 samples:
   119 	@$(ECHO) '  MKDIR $@'
   120 	$(SILENT)mkdir -p $@
   121 
   122 # Save a sample
   123 saveconfig: .config samples
   124 	$(SILENT)$(CT_LIB_DIR)/scripts/saveSample.sh
   125 
   126 # The 'sample_dir' function prints the directory in which the sample is,
   127 # searching first in local samples, then in global samples
   128 define sample_dir
   129 $$( [ -d $(CT_TOP_DIR)/samples/$(1) ] && echo "$(CT_TOP_DIR)/samples/$(1)" || echo "$(CT_LIB_DIR)/samples/$(1)")
   130 endef
   131 
   132 # How we do recall one sample
   133 PHONY += $(CT_SAMPLES)
   134 $(CT_SAMPLES): config_files
   135 	@$(ECHO) "  CONF  $(KCONFIG_TOP)"
   136 	$(SILENT)$(CONF) --defconfig=$(call sample_dir,$@)/crosstool.config $(KCONFIG_TOP)
   137 	@echo
   138 	@echo  '***********************************************************'
   139 	@echo
   140 	$(SILENT)( . $(call sample_dir,$@)/reported.by;                             \
   141 	   echo "Initially reported by: $${reporter_name}";                         \
   142 	   echo "URL: $${reporter_url}";                                            \
   143 	   if [ -n "$${reporter_comment}" ]; then                                   \
   144 	     echo  ;                                                                \
   145 	     echo  "Comment:";                                                      \
   146 	     printf "$${reporter_comment}\n";                                       \
   147 	   fi;                                                                      \
   148 	   echo  ;                                                                  \
   149 	   echo  '***********************************************************';     \
   150 	 )
   151 	$(SILENT)if $(grep) -E '^CT_EXPERIMENTAL=y$$' .config >/dev/null 2>&1; then \
   152 	   echo  ;                                                                  \
   153 	   echo  'WARNING! This sample may enable experimental features.';          \
   154 	   echo  '         Please be sure to review the configuration prior';       \
   155 	   echo  '         to building and using your toolchain!';                  \
   156 	   echo  'Now, you have been warned!';                                      \
   157 	   echo  ;                                                                  \
   158 	   echo  '***********************************************************';     \
   159 	 fi
   160 	@echo
   161 	@echo  'Now configured for "$@"'
   162 
   163 # ----------------------------------------------------------
   164 # Some helper functions
   165 
   166 # Create the rule to build a sample
   167 # $1: sample tuple
   168 # $2: prefix
   169 define build_sample
   170 	@$(ECHO) '  CONF  $(1)'
   171 	$(SILENT)cp $(call sample_dir,$(1))/crosstool.config .config
   172 	$(SILENT)$(sed) -i -r -e 's:^(CT_PREFIX_DIR=).*$$:\1"$(2)":;' .config
   173 	$(SILENT)$(sed) -i -r -e 's:^.*(CT_LOG_(WARN|INFO|EXTRA|DEBUG|ALL)).*$$:# \1 is not set:;' .config
   174 	$(SILENT)$(sed) -i -r -e 's:^.*(CT_LOG_ERROR).*$$:\1=y:;' .config
   175 	$(SILENT)$(sed) -i -r -e 's:^(CT_LOG_LEVEL_MAX)=.*$$:\1="ERROR":;' .config
   176 	$(SILENT)$(sed) -i -r -e 's:^.*(CT_LOG_TO_FILE).*$$:\1=y:;' .config
   177 	$(SILENT)$(sed) -i -r -e 's:^.*(CT_LOG_PROGRESS_BAR).*$$:\1=y:;' .config
   178 	$(SILENT)$(MAKE) -rf $(CT_NG) V=0 oldconfig
   179 	@$(ECHO) '  BUILD $(1)'
   180 	$(SILENT)$(MAKE) -rf $(CT_NG) V=0 build
   181 endef
   182 
   183 # ----------------------------------------------------------
   184 # Build samples for use (not regtest!)
   185 
   186 # Check that PREFIX is set if building samples
   187 ifneq ($(strip $(MAKECMDGOALS)),)
   188 ifneq ($(strip $(filter $(patsubst %,build-%,$(CT_SAMPLES)) build-all,$(MAKECMDGOALS))),)
   189 
   190 ifeq ($(strip $(CT_PREFIX)),)
   191 $(error Please set 'CT_PREFIX' to where you want to install generated toolchain samples!)
   192 endif
   193 
   194 endif # MAKECMDGOALS contains a build sample rule
   195 endif # MAKECMDGOALS != ""
   196 
   197 # Build a single sample
   198 $(patsubst %,build-%,$(CT_SAMPLES)):
   199 	$(call build_sample,$(patsubst build-%,%,$@),$(CT_PREFIX)/$(patsubst build-%,%,$@))
   200 
   201 # Build al samples
   202 build-all: $(patsubst %,build-%,$(CT_SAMPLES))
   203 
   204 # Build all samples, overiding the number of // jobs per sample
   205 build-all.%:
   206 	$(SILENT)$(MAKE) -rf $(CT_NG) V=$(V) $(shell echo "$(@)" |$(sed) -r -e 's|^([^.]+)\.([[:digit:]]+)$$|\1 CT_JOBS=\2|;')
   207